manpagez: man pages & more
man CURLOPT_LOW_SPEED_LIMIT(3)
Home | html | info | man
CURLOPT_LOW_SPEED_LIMIT(3)                            Library Functions Manual


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
       CURLOPT_LOW_SPEED_TIME(3) seconds for libcurl to consider it to be too
       slow and abort.


DEFAULT

       0, disabled


PROTOCOLS

       This functionality affects all supported protocols


EXAMPLE

       int main(void)
       {
         CURL *curl = curl_easy_init();
         if(curl) {
           CURLcode res;
           curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
           /* 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

       Added in curl 7.1


RETURN VALUE

       Returns CURLE_OK


SEE ALSO

       CURLOPT_LOW_SPEED_TIME(3), CURLOPT_MAX_RECV_SPEED_LARGE(3),
       CURLOPT_MAX_SEND_SPEED_LARGE(3), CURLOPT_TIMEOUT(3)

libcurl                           2024-08-05        CURLOPT_LOW_SPEED_LIMIT(3)

curl 8.9.1 - Generated Fri Aug 9 08:25:33 CDT 2024
© manpagez.com 2000-2024
Individual documents may contain additional copyright information.