repo/core/curl/files/CURLOPT_CONNECTTIMEOUT_MS.3

.\" generated by cd2nroff 0.1 from CURLOPT_CONNECTTIMEOUT_MS.md
.TH CURLOPT_CONNECTTIMEOUT_MS 3 "2024-07-29" libcurl
.SH NAME
CURLOPT_CONNECTTIMEOUT_MS \- timeout for the connect phase
.SH SYNOPSIS
.nf
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONNECTTIMEOUT_MS,
                          long timeout);
.fi
.SH 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 \fICURLOPT_TIMEOUT_MS(3)\fP option.

\fICURLOPT_CONNECTTIMEOUT(3)\fP is the same function but set in seconds.

If both \fICURLOPT_CONNECTTIMEOUT(3)\fP and \fICURLOPT_CONNECTTIMEOUT_MS(3)\fP are set,
the value set last is used.

The connection timeout is included in the general all\-covering
\fICURLOPT_TIMEOUT_MS(3)\fP:

With \fICURLOPT_CONNECTTIMEOUT_MS(3)\fP set to 3000 and \fICURLOPT_TIMEOUT_MS(3)\fP set to
5000, the operation can never last longer than 5000 milliseconds, and the
connection phase cannot last longer than 3000 milliseconds.

With \fICURLOPT_CONNECTTIMEOUT_MS(3)\fP set to 4000 and \fICURLOPT_TIMEOUT_MS(3)\fP 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 \fICURLOPT_NOSIGNAL(3)\fP is set.
.SH DEFAULT
300000
.SH PROTOCOLS
This functionality affects all supported protocols
.SH EXAMPLE
.nf
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);
  }
}
.fi
.SH AVAILABILITY
Added in curl 7.16.2
.SH RETURN VALUE
Returns CURLE_OK
.SH SEE ALSO
.BR CURLOPT_LOW_SPEED_LIMIT (3),
.BR CURLOPT_MAX_RECV_SPEED_LARGE (3),
.BR CURLOPT_TIMEOUT_MS (3)