Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_CONNECTTIMEOUT_MS (3)

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

curl_easy_setopt options                          CURLOPT_CONNECTTIMEOUT_MS(3)



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 sec-
       onds. See also the CURLOPT_TIMEOUT_MS(3) option.

       In unix-like systems, this might cause signals to be used  unless  CUR-
       LOPT_NOSIGNAL(3) is set.

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

DEFAULT
       300000

PROTOCOLS
       All

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "http://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


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_CONNECTTIMEOUT(3),           CURLOPT_TIMEOUT(3),           CUR-
       LOPT_LOW_SPEED_LIMIT(3),



NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was    downloaded    from    https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.37.0                    17 Jun 2014
                                                  CURLOPT_CONNECTTIMEOUT_MS(3)