2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from CURLOPT_CONNECTTIMEOUT_MS.md
|
2024-06-01 14:49:19 -06:00
|
|
|
.TH CURLOPT_CONNECTTIMEOUT_MS 3 "2024-06-01" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.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 should contain the maximum time in milliseconds that you allow
|
|
|
|
|
the connection phase to the server to take.
|
|
|
|
|
|
|
|
|
|
See \fICURLOPT_CONNECTTIMEOUT(3)\fP for details.
|
|
|
|
|
.SH DEFAULT
|
|
|
|
|
300000
|
|
|
|
|
.SH PROTOCOLS
|
|
|
|
|
All
|
|
|
|
|
.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
|
|
|
|
|
Always
|
|
|
|
|
.SH RETURN VALUE
|
|
|
|
|
Returns CURLE_OK
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR CURLOPT_CONNECTTIMEOUT (3),
|
|
|
|
|
.BR CURLOPT_LOW_SPEED_LIMIT (3),
|
|
|
|
|
.BR CURLOPT_TIMEOUT (3)
|
