mirror of
https://github.com/curl/curl.git
synced 2025-02-17 14:59:45 +08:00
The mandatory header now has a mandatory list of protocols for which the manpage is relevant. Most man pages already has a "PROTOCOLS" section, but this introduces a stricter way to specify the relevant protocols. cd2nroff verifies that at least one protocol is mentioned (which can be `*`). This information is not used just yet, but A) the PROTOCOLS section can now instead get generated and get a unified wording across all manpages and B) this allows us to more reliably filter/search for protocol specific manpages/options. Closes #13166
1.5 KiB
1.5 KiB
c: Copyright (C) Daniel Stenberg, daniel@haxx.se, et al.
SPDX-License-Identifier: curl
Title: CURLOPT_MAX_RECV_SPEED_LARGE
Section: 3
Source: libcurl
See-also:
- CURLOPT_LOW_SPEED_LIMIT (3)
- CURLOPT_MAX_SEND_SPEED_LARGE (3)
- CURLOPT_TIMEOUT (3)
Protocol:
- *
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
All but file://
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
Added in 7.15.5
RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.