Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_LOW_SPEED_LIMIT (3)

Name

CURLOPT_LOW_SPEED_LIMIT - low speed limit in bytes per second

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOW_SPEED_LIMIT,
long speedlimit);

Description

curl_easy_setopt options                            CURLOPT_LOW_SPEED_LIMIT(3)



NAME
       CURLOPT_LOW_SPEED_LIMIT - low speed limit in bytes per second

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOW_SPEED_LIMIT,
                                 long speedlimit);

DESCRIPTION
       Pass  a  long  as  parameter. It contains the average transfer speed in
       bytes per  second  that  the  transfer  should  be  below  during  CUR-
       LOPT_LOW_SPEED_TIME(3)  seconds  for  libcurl  to consider it to be too
       slow and abort.

DEFAULT
       0, disabled

PROTOCOLS
       All

EXAMPLE
       curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, url);
         /* abort if slower than 30 bytes/sec during 60 seconds */
         curl_easy_setopt(curl, CURLOPT_LOW_SPEED_TIME, 60L);
         curl_easy_setopt(curl, CURLOPT_LOW_SPEED_LIMIT, 30L);
         res = curl_easy_perform(curl);
         if(CURLE_OPERATION_TIMEDOUT == res) {
           printf("Timeout!\n");
         }
         /* always cleanup */
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Always

RETURN VALUE
       Returns CURLE_OK


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


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       CURLOPT_LOW_SPEED_TIME(3), CURLOPT_TIMEOUT(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                 November 26, 2021
                                                    CURLOPT_LOW_SPEED_LIMIT(3)