CURLOPT_MAX_RECV_SPEED_LARGE(3)

1CURLOPT_MAX_RECV_SPEED_LARGEc(u3r)l_easy_setopt optiCoUnRsLOPT_MAX_RECV_SPEED_LARGE(3)
2
3
4

NAME

6       CURLOPT_MAX_RECV_SPEED_LARGE - rate limit data download speed
7

SYNOPSIS

9       #include <curl/curl.h>
10
11       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAX_RECV_SPEED_LARGE,
12                                 curl_off_t speed);
13

DESCRIPTION

15       Pass  a  curl_off_t  as  parameter.   If  a download exceeds this speed
16       (counted in bytes per second) the transfer will pause to keep the speed
17       less than or equal to the parameter value. Defaults to unlimited speed.
18
19       This option doesn't affect transfer speeds done with FILE:// URLs.
20

DEFAULT

22       0, disabled
23

PROTOCOLS

25       All but file://
26

EXAMPLE

28       CURL *curl = curl_easy_init();
29       if(curl) {
30         CURLcode ret;
31         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
32         /* cap the download speed to 31415 bytes/sec */
33         curl_easy_setopt(curl, CURLOPT_MAX_RECV_SPEED_LARGE, (curl_off_t)31415);
34         ret = curl_easy_perform(curl);
35       }
36

AVAILABILITY

38       Added in 7.15.5
39

RETURN VALUE

41       Returns  CURLE_OK  if the option is supported, and CURLE_UNKNOWN_OPTION
42       if not.
43