docs/libcurl/opts/CURLOPT_CONNECTTIMEOUT_MS.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.
   9 .\" *
  10 .\" * This software is licensed as described in the file COPYING, which
  11 .\" * you should have received as part of this distribution. The terms
  12 .\" * are also available at http://curl.haxx.se/docs/copyright.html.
  13 .\" *
  14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15 .\" * copies of the Software, and permit persons to whom the Software is
  16 .\" * furnished to do so, under the terms of the COPYING file.
  17 .\" *
  18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19 .\" * KIND, either express or implied.
  20 .\" *
  21 .\" **************************************************************************
  22 .\"
  23 .TH CURLOPT_CONNECTTIMEOUT_MS 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_CONNECTTIMEOUT_MS \- timeout for the connect phase
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONNECTTIMEOUT_MS, long timeout);
  30 .SH DESCRIPTION
  31 Pass a long. It should contain the maximum time in milliseconds that you allow
  32 the connection phase to the server to take.  This only limits the connection
  33 phase, it has no impact once it has connected. Set to zero to switch to the
  34 default built-in connection timeout - 300 seconds. See also the
  35 \fICURLOPT_TIMEOUT_MS(3)\fP option.
  36
  37 In unix-like systems, this might cause signals to be used unless
  38 \fICURLOPT_NOSIGNAL(3)\fP is set.
  39 .SH DEFAULT
  40 300000
  41 .SH PROTOCOLS
  42 All
  43 .SH EXAMPLE
  44 .nf
  45 CURL *curl = curl_easy_init();
  46 if(curl) {
  47   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  48
  49   /* complete connection within 10000 milliseconds */
  50   curl_easy_setopt(curl, CURLOPT_CONNECTTIMEOUT, 10000L);
  51
  52   curl_easy_perform(curl);
  53 }
  54 .fi
  55 .SH AVAILABILITY
  56 Always
  57 .SH RETURN VALUE
  58 Returns CURLE_OK
  59 .SH "SEE ALSO"
  60 .BR CURLOPT_TIMEOUT "(3), " CURLOPT_LOW_SPEED_LIMIT "(3), "