curl / libcurl / API / curl_easy_setopt / CURLOPT_TIMEOUT_MS

CURLOPT_TIMEOUT_MS explained

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 milliseconds that you allow the libcurl transfer operation to take.

See CURLOPT_TIMEOUT for details.

Default

0 (zero) which means it never times out during transfer.

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 within 20000 milliseconds */
    curl_easy_setopt(curl, CURLOPT_TIMEOUT_MS, 20000L);
 
    curl_easy_perform(curl);
  }
}

Availability

Added in curl 7.16.2

Return value

Returns CURLE_OK