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


NAME

       CURLOPT_LOW_SPEED_TIME - low speed limit time period


SYNOPSIS

       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOW_SPEED_TIME,
                                 long speedtime);


DESCRIPTION

       Pass a long as parameter. It contains the time in number seconds that
       the transfer speed should be below the CURLOPT_LOW_SPEED_LIMIT(3) for
       the library to consider it 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_LIMIT(3), CURLOPT_TIMEOUT(3)

libcurl                           2024-08-05         CURLOPT_LOW_SPEED_TIME(3)

curl 8.9.1 - Generated Mon Aug 12 15:23:19 CDT 2024
© manpagez.com 2000-2024
Individual documents may contain additional copyright information.