curl / libcurl / API / curl_easy_setopt / CURLOPT_SERVER_RESPONSE_TIMEOUT_MS

CURLOPT_SERVER_RESPONSE_TIMEOUT_MS explained

Name

CURLOPT_SERVER_RESPONSE_TIMEOUT_MS - time allowed to wait for server response

Synopsis

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

Description

Pass a long. It tells libcurl to wait no longer than timeout milliseconds 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_MS to a value smaller than CURLOPT_TIMEOUT.

The maximum accepted value is 2147483648.

This is the millisecond version of CURLOPT_SERVER_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 237 milliseconds */
    curl_easy_setopt(curl, CURLOPT_SERVER_RESPONSE_TIMEOUT_MS, 237L);
    res = curl_easy_perform(curl);
 
    curl_easy_cleanup(curl);
  }
}

Availability

Added in curl 8.6.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.