Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_MAX_SEND_SPEED_LARGE (3)

Name

CURLOPT_MAX_SEND_SPEED_LARGE - rate limit data upload speed

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAX_SEND_SPEED_LARGE,
curl_off_t maxspeed);

Description

curl_easy_setopt options                       CURLOPT_MAX_SEND_SPEED_LARGE(3)



NAME
       CURLOPT_MAX_SEND_SPEED_LARGE - rate limit data upload speed

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAX_SEND_SPEED_LARGE,
                                 curl_off_t maxspeed);

DESCRIPTION
       Pass a curl_off_t as parameter with the maxspeed.  If an upload exceeds
       this speed (counted in bytes per second) the  transfer  will  pause  to
       keep  the speed less than or equal to the parameter value.  Defaults to
       unlimited speed.

       This option doesn't affect transfer speeds done with FILE:// URLs.

DEFAULT
       0, disabled

PROTOCOLS
       All except file://

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         CURLcode ret;
         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
         /* cap the upload speed to 1000 bytes/sec */
         curl_easy_setopt(curl, CURLOPT_MAX_SEND_SPEED_LARGE, (curl_off_t)1000);
         /* (set some upload options as well!) */
         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.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_MAX_RECV_SPEED_LARGE(3), CURLOPT_LOW_SPEED_LIMIT(3),



NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was    downloaded    from    https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.37.0                    19 Jun 2014
                                               CURLOPT_MAX_SEND_SPEED_LARGE(3)