curl / libcurl / API / curl_easy_setopt / CURLOPT_LOW_SPEED_LIMIT

CURLOPT_LOW_SPEED_LIMIT explained

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 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