Debian Codegraph @

deps/curl/docs/libcurl/opts/CURLOPT_LOW_SPEED_TIME.3

raw
1 .\" **************************************************************************
2 .\" * _ _ ____ _
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <[email protected]>, 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 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_LOW_SPEED_TIME \- set low speed limit time period
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOW_SPEED_TIME, long speedtime);
30 .SH DESCRIPTION
31 Pass a long as parameter. It contains the time in number seconds that the
32 transfer speed should be below the \fICURLOPT_LOW_SPEED_LIMIT(3)\fP for the
33 library to consider it too slow and abort.
34 .SH DEFAULT
35 0, disabled
36 .SH PROTOCOLS
37 All
38 .SH EXAMPLE
39 .nf
40 curl = curl_easy_init();
41 if(curl) {
42 curl_easy_setopt(curl, CURLOPT_URL, url);
43 /* abort if slower than 30 bytes/sec during 60 seconds */
44 curl_easy_setopt(curl, CURLOPT_LOW_SPEED_TIME, 60L);
45 curl_easy_setopt(curl, CURLOPT_LOW_SPEED_LIMIT, 30L);
46 res = curl_easy_perform(curl);
47 if(CURLE_OPERATION_TIMEDOUT == res) {
48 printf("Timeout!\\n");
49 }
50 /* always cleanup */
51 curl_easy_cleanup(curl);
52 }
53 .fi
54 .SH AVAILABILITY
55 Always
56 .SH RETURN VALUE
57 Returns CURLE_OK
58 .SH "SEE ALSO"
59 .BR CURLOPT_LOW_SPEED_LIMIT "(3), " CURLOPT_TIMEOUT "(3), "