Tribblix: manual page: CURLOPT_LOW_SPEED

CURLOPT_LOW_SPEED_TIME(3) Introduction to Library Functions

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

curl_easy_setopt(3) returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error
occurred, see libcurl-errors(3).