Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_LOW_SPEED_TIME.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
9: .\" *
10: .\" * This software is licensed as described in the file COPYING, which
11: .\" * you should have received as part of this distribution. The terms
12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13: .\" *
14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15: .\" * copies of the Software, and permit persons to whom the Software is
16: .\" * furnished to do so, under the terms of the COPYING file.
17: .\" *
18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19: .\" * KIND, either express or implied.
20: .\" *
21: .\" **************************************************************************
22: .\"
23: .TH CURLOPT_LOW_SPEED_TIME 3 "May 06, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_LOW_SPEED_TIME \- set low speed limit time period
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOW_SPEED_TIME, long speedtime);
31: .SH DESCRIPTION
32: Pass a long as parameter. It contains the time in number seconds that the
33: transfer speed should be below the \fICURLOPT_LOW_SPEED_LIMIT(3)\fP for the
34: library to consider it too slow and abort.
35: .SH DEFAULT
36: 0, disabled
37: .SH PROTOCOLS
38: All
39: .SH EXAMPLE
40: .nf
41: curl = curl_easy_init();
42: if(curl) {
43: curl_easy_setopt(curl, CURLOPT_URL, url);
44: /* abort if slower than 30 bytes/sec during 60 seconds */
45: curl_easy_setopt(curl, CURLOPT_LOW_SPEED_TIME, 60L);
46: curl_easy_setopt(curl, CURLOPT_LOW_SPEED_LIMIT, 30L);
47: res = curl_easy_perform(curl);
48: if(CURLE_OPERATION_TIMEDOUT == res) {
49: printf("Timeout!\\n");
50: }
51: /* always cleanup */
52: curl_easy_cleanup(curl);
53: }
54: .fi
55: .SH AVAILABILITY
56: Always
57: .SH RETURN VALUE
58: Returns CURLE_OK
59: .SH "SEE ALSO"
60: .BR CURLOPT_LOW_SPEED_LIMIT "(3), " CURLOPT_TIMEOUT "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>