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 should contain the maximum time in milliseconds that you allow the connection phase to the server to take. This only limits the connection phase, it has no impact once it has connected. Set to zero to switch to the default built-in connection timeout - 300 seconds. See also the CURLOPT_TIMEOUT_MS option.

In unix-like systems, this might cause signals to be used unless CURLOPT_NOSIGNAL is set.

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

The "connection phase" is considered complete when the requested TCP, TLS or QUIC handshakes are done.

Default

300000

Protocols

All

Example

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

Always

Return value

Returns CURLE_OK