mirror of
https://github.com/curl/curl.git
synced 2024-12-21 06:50:10 +08:00
5a488251f7
- make DEFAULT sections less repetitive - make historic mentions use HISTORY - generate the protocols section on `# %PROTOCOLS%` instead of guessing where to put it - generate the availability section on `# %AVAILABILITY%` instead of guessing where to put it - make the protocols section more verbose Closes #14227
1.5 KiB
1.5 KiB
c | SPDX-License-Identifier | Title | Section | Source | See-also | Protocol | Added-in | ||||
---|---|---|---|---|---|---|---|---|---|---|---|
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. | curl | CURLOPT_MAX_RECV_SPEED_LARGE | 3 | libcurl |
|
|
7.15.5 |
NAME
CURLOPT_MAX_RECV_SPEED_LARGE - rate limit data download speed
SYNOPSIS
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAX_RECV_SPEED_LARGE,
curl_off_t maxspeed);
DESCRIPTION
Pass a curl_off_t as parameter. If a download exceeds this maxspeed (counted in bytes per second) the transfer pauses to keep the average speed less than or equal to the parameter value. Defaults to unlimited speed.
This is not an exact science. libcurl attempts to keep the average speed below the given threshold over a period time.
If you set maxspeed to a value lower than CURLOPT_BUFFERSIZE(3), libcurl might download faster than the set limit initially.
This option does not affect transfer speeds done with FILE:// URLs.
DEFAULT
0, disabled
%PROTOCOLS%
EXAMPLE
int main(void)
{
CURL *curl = curl_easy_init();
if(curl) {
CURLcode ret;
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
/* cap the download speed to 31415 bytes/sec */
curl_easy_setopt(curl, CURLOPT_MAX_RECV_SPEED_LARGE, (curl_off_t)31415);
ret = curl_easy_perform(curl);
}
}
%AVAILABILITY%
RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.