CURLOPT_MAX_SEND_SPEED_LARGE(3)

1CURLOPT_MAX_SEND_SPEED_LARGEc(u3r)l_easy_setopt optiCoUnRsLOPT_MAX_SEND_SPEED_LARGE(3)
2
3
4

NAME

6       CURLOPT_MAX_SEND_SPEED_LARGE - rate limit data upload speed
7

SYNOPSIS

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

DESCRIPTION

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

DEFAULT

23       0, disabled
24

PROTOCOLS

26       All except file://
27

EXAMPLE

29       CURL *curl = curl_easy_init();
30       if(curl) {
31         CURLcode ret;
32         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
33         /* cap the upload speed to 1000 bytes/sec */
34         curl_easy_setopt(curl, CURLOPT_MAX_SEND_SPEED_LARGE, (curl_off_t)1000);
35         /* (set some upload options as well!) */
36         ret = curl_easy_perform(curl);
37       }
38

AVAILABILITY

40       Added in 7.15.5
41

RETURN VALUE

43       Returns CURLE_OK if the option is supported,  and  CURLE_UNKNOWN_OPTION
44       if not.
45