man pages section 3: Library Interfaces and Headers

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

CURLOPT_LOW_SPEED_TIME(3)  curl_easy_setopt options  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
       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_LIMIT(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_TIME(3)