Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_FTP_RESPONSE_TIMEOUT.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_FTP_RESPONSE_TIMEOUT 3 "October 03, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_FTP_RESPONSE_TIMEOUT \- time allowed to wait for FTP response
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTP_RESPONSE_TIMEOUT, long timeout);
31: .SH DESCRIPTION
32: Pass a long. Causes libcurl to set a \fItimeout\fP period (in seconds) on the
33: amount of time that the server is allowed to take in order to send a response
34: message for a command before the session is considered dead. While libcurl is
35: waiting for a response, this value overrides \fICURLOPT_TIMEOUT(3)\fP. It is
36: recommended that if used in conjunction with \fICURLOPT_TIMEOUT(3)\fP, you set
37: \fICURLOPT_FTP_RESPONSE_TIMEOUT(3)\fP to a value smaller than
38: \fICURLOPT_TIMEOUT(3)\fP.
39: .SH DEFAULT
40: None
41: .SH PROTOCOLS
42: FTP
43: .SH EXAMPLE
44: .nf
45: CURL *curl = curl_easy_init();
46: if(curl) {
47: curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/slow.txt");
48: /* wait no more than 23 seconds */
49: curl_easy_setopt(curl, CURLOPT_FTP_RESPONSE_TIMEOUT, 23L);
50: ret = curl_easy_perform(curl);
51:
52: curl_easy_cleanup(curl);
53: }
54: .fi
55: .SH AVAILABILITY
56: Added in 7.10.8
57: .SH RETURN VALUE
58: Returns CURLE_OK if FTP is supported, and CURLE_UNKNOWN_OPTION if not. Returns
59: CURLE_BAD_FUNCTION_ARGUMENT if set to a negative value or a value that when
60: converted to milliseconds is too large.
61: .SH "SEE ALSO"
62: .BR CURLOPT_TIMEOUT "(3), " CURLOPT_CONNECTTIMEOUT "(3), "
63: .BR CURLOPT_LOW_SPEED_LIMIT "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>