| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849 |
- .\" generated by cd2nroff 0.1 from CURLOPT_LOW_SPEED_LIMIT.md
- .TH CURLOPT_LOW_SPEED_LIMIT 3 "2025-01-17" libcurl
- .SH NAME
- CURLOPT_LOW_SPEED_LIMIT \- low speed limit in bytes per second
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOW_SPEED_LIMIT,
- long speedlimit);
- .fi
- .SH DESCRIPTION
- Pass a long as parameter. It contains the average transfer speed in bytes per
- second that the transfer should be below during
- \fICURLOPT_LOW_SPEED_TIME(3)\fP seconds for libcurl to consider it to be too
- slow and abort.
- .SH DEFAULT
- 0, disabled
- .SH PROTOCOLS
- This functionality affects all supported protocols
- .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
- Added in curl 7.1
- .SH RETURN VALUE
- Returns CURLE_OK
- .SH SEE ALSO
- .BR CURLOPT_LOW_SPEED_TIME (3),
- .BR CURLOPT_MAX_RECV_SPEED_LARGE (3),
- .BR CURLOPT_MAX_SEND_SPEED_LARGE (3),
- .BR CURLOPT_TIMEOUT (3)
|