mirror of
https://codeberg.org/kiss-community/repo
synced 2024-08-19 12:46:58 +00:00
47 lines
1.2 KiB
Groff
47 lines
1.2 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLOPT_LOW_SPEED_TIME.md
|
|
.TH CURLOPT_LOW_SPEED_TIME 3 "2024-06-01" libcurl
|
|
.SH NAME
|
|
CURLOPT_LOW_SPEED_TIME \- low speed limit time period
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOW_SPEED_TIME,
|
|
long speedtime);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a long as parameter. It contains the time in number seconds that the
|
|
transfer speed should be below the \fICURLOPT_LOW_SPEED_LIMIT(3)\fP for the
|
|
library to consider it too slow and abort.
|
|
.SH DEFAULT
|
|
0, disabled
|
|
.SH PROTOCOLS
|
|
All
|
|
.SH EXAMPLE
|
|
.nf
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
CURLcode res;
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
|
/* abort if slower than 30 bytes/sec during 60 seconds */
|
|
curl_easy_setopt(curl, CURLOPT_LOW_SPEED_TIME, 60L);
|
|
curl_easy_setopt(curl, CURLOPT_LOW_SPEED_LIMIT, 30L);
|
|
res = curl_easy_perform(curl);
|
|
if(CURLE_OPERATION_TIMEDOUT == res) {
|
|
printf("Timeout!\\n");
|
|
}
|
|
/* always cleanup */
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Always
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK
|
|
.SH SEE ALSO
|
|
.BR CURLOPT_LOW_SPEED_LIMIT (3),
|
|
.BR CURLOPT_TIMEOUT (3)
|