diff options
Diffstat (limited to 'docs/libcurl/opts/GNURLOPT_LOW_SPEED_LIMIT.3')
| -rw-r--r-- | docs/libcurl/opts/GNURLOPT_LOW_SPEED_LIMIT.3 | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/docs/libcurl/opts/GNURLOPT_LOW_SPEED_LIMIT.3 b/docs/libcurl/opts/GNURLOPT_LOW_SPEED_LIMIT.3 new file mode 100644 index 000000000..4f26e6656 --- /dev/null +++ b/docs/libcurl/opts/GNURLOPT_LOW_SPEED_LIMIT.3 @@ -0,0 +1,60 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * +.\" * This software is licensed as described in the file COPYING, which +.\" * you should have received as part of this distribution. The terms +.\" * are also available at https://curl.haxx.se/docs/copyright.html. +.\" * +.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell +.\" * copies of the Software, and permit persons to whom the Software is +.\" * furnished to do so, under the terms of the COPYING file. +.\" * +.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY +.\" * KIND, either express or implied. +.\" * +.\" ************************************************************************** +.\" +.TH GNURLOPT_LOW_SPEED_LIMIT 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_LOW_SPEED_LIMIT \- set low speed limit in bytes per second +.SH SYNOPSIS +#include <gnurl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOW_SPEED_LIMIT, long speedlimit); +.SH DESCRIPTION +Pass a long as parameter. It contains the average transfer speed in bytes per +second that the transfer should be below during +\fICURLOPT_LOW_SPEED_TIME(3)\fP seconds for libcurl to consider it to be too +slow and abort. +.SH DEFAULT +0, disabled +.SH PROTOCOLS +All +.SH EXAMPLE +.nf +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); +} +.fi +.SH AVAILABILITY +Always +.SH RETURN VALUE +Returns CURLE_OK +.SH "SEE ALSO" +.BR CURLOPT_LOW_SPEED_TIME "(3), " CURLOPT_TIMEOUT "(3), " |