curl / libcurl / API / curl_easy_setopt / CURLOPT_CONNECTTIMEOUT_MS

CURLOPT_CONNECTTIMEOUT_MS explained

Name

CURLOPT_CONNECTTIMEOUT_MS - timeout for the connect phase

Synopsis

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

Description

Pass a long. It sets the maximum time in milliseconds that you allow the connection phase to take. This timeout only limits the connection phase, it has no impact once libcurl has connected. The connection phase includes the name resolve (DNS) and all protocol handshakes and negotiations until there is an established connection with the remote side.

Set this option to zero to switch to the default built-in connection timeout - 300 seconds. See also the CURLOPT_TIMEOUT_MS option.

CURLOPT_CONNECTTIMEOUT is the same function but set in seconds.

If both CURLOPT_CONNECTTIMEOUT and CURLOPT_CONNECTTIMEOUT_MS are set, the value set last is used.

The connection timeout is included in the general all-covering CURLOPT_TIMEOUT_MS:

With CURLOPT_CONNECTTIMEOUT_MS set to 3000 and CURLOPT_TIMEOUT_MS set to 5000, the operation can never last longer than 5000 milliseconds, and the connection phase cannot last longer than 3000 milliseconds.

With CURLOPT_CONNECTTIMEOUT_MS set to 4000 and CURLOPT_TIMEOUT_MS set to 2000, the operation can never last longer than 2000 milliseconds. Including the connection phase.

This option may cause libcurl to use the SIGALRM signal to timeout system calls on builds not using asynch DNS. In Unix-like systems, this might cause signals to be used unless CURLOPT_NOSIGNAL is set.

Default

300000

Protocols

This functionality affects all supported protocols

Example

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
 
    /* complete connection within 10000 milliseconds */
    curl_easy_setopt(curl, CURLOPT_CONNECTTIMEOUT_MS, 10000L);
 
    curl_easy_perform(curl);
  }
}

Availability

Added in curl 7.16.2

Return value

Returns CURLE_OK