76 lines
1.8 KiB
Markdown
76 lines
1.8 KiB
Markdown
|
---
|
||
|
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
||
|
|
SPDX-License-Identifier: curl
|
||
|
|
Title: CURLOPT_SERVER_RESPONSE_TIMEOUT
|
||
|
|
Section: 3
|
||
|
|
Source: libcurl
|
||
|
|
See-also:
|
||
|
|
- CURLOPT_CONNECTTIMEOUT (3)
|
||
|
|
- CURLOPT_LOW_SPEED_LIMIT (3)
|
||
|
|
- CURLOPT_TIMEOUT (3)
|
||
|
|
---
|
||
|
|
|
||
|
|
# NAME
|
||
|
|
|
||
|
|
CURLOPT_SERVER_RESPONSE_TIMEOUT - time allowed to wait for server response
|
||
|
|
|
||
|
|
# SYNOPSIS
|
||
|
|
|
||
|
|
~~~c
|
||
|
|
#include <curl/curl.h>
|
||
|
|
|
||
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SERVER_RESPONSE_TIMEOUT,
|
||
|
|
long timeout);
|
||
|
|
~~~
|
||
|
|
|
||
|
|
# DESCRIPTION
|
||
|
|
|
||
|
|
Pass a long. Causes libcurl to set a *timeout* period (in seconds) on the
|
||
|
|
amount of time that the server is allowed to take in order to send a response
|
||
|
|
message for a command before the session is considered dead. While libcurl is
|
||
|
|
waiting for a response, this value overrides CURLOPT_TIMEOUT(3). It is
|
||
|
|
recommended that if used in conjunction with CURLOPT_TIMEOUT(3), you set
|
||
|
|
CURLOPT_SERVER_RESPONSE_TIMEOUT(3) to a value smaller than
|
||
|
|
CURLOPT_TIMEOUT(3).
|
||
|
|
|
||
|
|
This option was formerly known as CURLOPT_FTP_RESPONSE_TIMEOUT.
|
||
|
|
|
||
|
|
# DEFAULT
|
||
|
|
|
||
|
|
None
|
||
|
|
|
||
|
|
# PROTOCOLS
|
||
|
|
|
||
|
|
FTP, IMAP, POP3, SMTP, and SSH
|
||
|
|
|
||
|
|
# EXAMPLE
|
||
|
|
|
||
|
|
~~~c
|
||
|
|
int main(void)
|
||
|
|
{
|
||
|
|
CURL *curl = curl_easy_init();
|
||
|
|
if(curl) {
|
||
|
|
CURLcode res;
|
||
|
|
curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/slow.txt");
|
||
|
|
/* wait no more than 23 seconds */
|
||
|
|
curl_easy_setopt(curl, CURLOPT_SERVER_RESPONSE_TIMEOUT, 23L);
|
||
|
|
res = curl_easy_perform(curl);
|
||
|
|
|
||
|
|
curl_easy_cleanup(curl);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
~~~
|
||
|
|
|
||
|
|
# AVAILABILITY
|
||
|
|
|
||
|
|
Added in 7.10.8. Used under this name since 7.20.0
|
||
|
|
|
||
|
|
Support for SSH is predicated on a new enough (1.11.0) version of libssh2
|
||
|
|
being available when compiling libcurl.
|
||
|
|
|
||
|
|
# RETURN VALUE
|
||
|
|
|
||
|
|
Returns CURLE_OK if supported, and CURLE_UNKNOWN_OPTION if not. Returns
|
||
|
|
CURLE_BAD_FUNCTION_ARGUMENT if set to a negative value or a value that when
|
||
|
|
converted to milliseconds is too large.
|