Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_LOW_SPEED_LIMIT (3)

Name

CURLOPT_LOW_SPEED_LIMIT - set 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 - set 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
       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                    17 Jun 2014
                                                    CURLOPT_LOW_SPEED_LIMIT(3)