Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

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 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_UPLOAD_BUFFERSIZE(3),
       libcurl might "shoot over" the limit on its first send and  still  send
       off a full buffer.

       This option does not 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
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source      was      downloaded       from        https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

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



libcurl 7.83.1                 October 31, 2021
                                               CURLOPT_MAX_SEND_SPEED_LARGE(3)