curl / libcurl / API / curl_easy_setopt / CURLOPT_SERVER_RESPONSE_TIMEOUT

CURLOPT_SERVER_RESPONSE_TIMEOUT explained

Name

CURLOPT_SERVER_RESPONSE_TIMEOUT - time allowed to wait for server response

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SERVER_RESPONSE_TIMEOUT,
                          long timeout);

Description

Pass a long. It tells libcurl to wait no longer than timeout seconds for responses on sent commands. If no response is received within this period, the connection is considered dead and the transfer fails.

It is recommended that if used in conjunction with CURLOPT_TIMEOUT, you set CURLOPT_SERVER_RESPONSE_TIMEOUT to a value smaller than CURLOPT_TIMEOUT.

This option was formerly known as CURLOPT_FTP_RESPONSE_TIMEOUT.

Default

None

Protocols

This functionality affects ftp, imap, pop3, scp, sftp and smtp

Example

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 curl 7.20.0

Return value

curl_easy_setopt returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors.