CURLOPT_TIMEOUT_MS(3) curl_easy_setopt options CURLOPT_TIMEOUT_MS(3)
NAME
CURLOPT_TIMEOUT_MS - maximum time the transfer is allowed to complete
SYNOPSIS
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TIMEOUT_MS, long timeout);
DESCRIPTION
Pass a long as parameter containing timeout - the maximum time in mil-
liseconds that you allow the libcurl transfer operation to take. Nor-
mally, name lookups can take a considerable time and limiting opera-
tions to less than a few minutes risk aborting perfectly normal opera-
tions. This option may cause libcurl to use the SIGALRM signal to time-
out system calls.
If libcurl is built to use the standard system name resolver, that por-
tion of the transfer will still use full-second resolution for timeouts
with a minimum timeout allowed of one second.
In unix-like systems, this might cause signals to be used unless CUR-
LOPT_NOSIGNAL(3) is set.
If both CURLOPT_TIMEOUT(3) and CURLOPT_TIMEOUT_MS(3) are set, the value
set last will be used.
Since this puts a hard limit for how long time a request is allowed to
take, it has limited use in dynamic use cases with varying transfer
times. You are then advised to explore CURLOPT_LOW_SPEED_LIMIT(3), CUR-
LOPT_LOW_SPEED_TIME(3) or using CURLOPT_PROGRESSFUNCTION(3) to imple-
ment your own timeout logic.
DEFAULT
Default timeout is 0 (zero) which means it never times out during
transfer.
PROTOCOLS
All
EXAMPLE
CURL *curl = curl_easy_init();
if(curl) {
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
/* complete within 20000 milliseconds */
curl_easy_setopt(curl, CURLOPT_TIMEOUT_MS, 20000L);
curl_easy_perform(curl);
}
AVAILABILITY
Always
RETURN VALUE
Returns CURLE_OK
SEE ALSO
CURLOPT_TIMEOUT(3), CURLOPT_CONNECTTIMEOUT(3), CUR-
LOPT_LOW_SPEED_LIMIT(3),
libcurl 7.81.0 November 26, 2021 CURLOPT_TIMEOUT_MS(3)
Generated by dwww version 1.14 on Sat Jan 18 10:04:34 CET 2025.