Debian Codegraph @

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