OpenSuSE Man Pages

Man Page or Keyword Search:
Man Architecture
Apropos Keyword Search (all sections) Output format
home | help
x SuSE Linux 13.1-RELEASE x
x SuSE Linux 13.1-RELEASEx
CURLOPT_CONNECTTIMEOUT(3)           libcurl          CURLOPT_CONNECTTIMEOUT(3)

NAME
       CURLOPT_CONNECTTIMEOUT - timeout for the connect phase

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONNECTTIMEOUT, long timeout);

DESCRIPTION
       Pass  a  long.  It  should contain the maximum time in seconds that you
       allow the connection phase to the server to  take.  This  timeout  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
       seconds. See also the CURLOPT_TIMEOUT(3) option.

       CURLOPT_CONNECTTIMEOUT_MS(3)  is the same function but set in millisec-
       onds.

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

       The  "connection  phase" is considered complete when the requested TCP,
       TLS or QUIC handshakes are done.

       The connection timeout set with CURLOPT_CONNECTTIMEOUT(3)  is  included
       in the general all-covering CURLOPT_TIMEOUT(3).

       With  CURLOPT_CONNECTTIMEOUT(3)  set to 3 and CURLOPT_TIMEOUT(3) set to
       5, the operation can never last longer than 5 seconds, and the  connec-
       tion phase cannot last longer than 3 seconds.

       With  CURLOPT_CONNECTTIMEOUT(3)  set to 4 and CURLOPT_TIMEOUT(3) set to
       2, the operation can never last longer than 2  seconds.  Including  the
       connection phase.

       This option may cause libcurl to use the SIGALRM signal to timeout sys-
       tem calls on builds not using asynch DNS. In  unix-like  systems,  this
       might cause signals to be used unless CURLOPT_NOSIGNAL(3) is set.

DEFAULT
       300

PROTOCOLS
       All

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");

         /* complete connection within 10 seconds */
         curl_easy_setopt(curl, CURLOPT_CONNECTTIMEOUT, 10L);

         curl_easy_perform(curl);
       }

AVAILABILITY
       Always

RETURN VALUE
       Returns CURLE_OK. Returns CURLE_BAD_FUNCTION_ARGUMENT if set to a nega-
       tive value or a value that when converted to milliseconds is too large.

SEE ALSO
       CURLOPT_CONNECTTIMEOUT_MS(3),     CURLOPT_LOW_SPEED_LIMIT(3),      CUR-
       LOPT_MAX_RECV_SPEED_LARGE(3), CURLOPT_TIMEOUT(3)

ibcurl 8.4.0                  September 26, 2023     CURLOPT_CONNECTTIMEOUT(3)

Want to link to this manual page? Use this URL:
<
http://star2.abcm.com/cgi-bin/bsdi-man?query=CURLOPT_CONNECTTIMEOUT&sektion=3&manpath=>

home | help