Return to CURLOPT_CONNECTTIMEOUT_MS.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_CONNECTTIMEOUT_MS.3, revision 1.1

1.1     ! misho       1: .\" **************************************************************************
        !             2: .\" *                                  _   _ ____  _
        !             3: .\" *  Project                     ___| | | |  _ \| |
        !             4: .\" *                             / __| | | | |_) | |
        !             5: .\" *                            | (__| |_| |  _ <| |___
        !             6: .\" *                             \___|\___/|_| \_\_____|
        !             7: .\" *
        !             8: .\" * Copyright (C) 1998 - 2020, 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 https://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 "March 23, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
        !            24: 
        !            25: .SH NAME
        !            26: CURLOPT_CONNECTTIMEOUT_MS \- timeout for the connect phase
        !            27: .SH SYNOPSIS
        !            28: #include <curl/curl.h>
        !            29: 
        !            30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONNECTTIMEOUT_MS, long timeout);
        !            31: .SH DESCRIPTION
        !            32: Pass a long. It should contain the maximum time in milliseconds that you allow
        !            33: the connection phase to the server to take.  This only limits the connection
        !            34: phase, it has no impact once it has connected. Set to zero to switch to the
        !            35: default built-in connection timeout - 300 seconds. See also the
        !            36: \fICURLOPT_TIMEOUT_MS(3)\fP option.
        !            37: 
        !            38: In unix-like systems, this might cause signals to be used unless
        !            39: \fICURLOPT_NOSIGNAL(3)\fP is set.
        !            40: 
        !            41: If both \fICURLOPT_CONNECTTIMEOUT(3)\fP and \fICURLOPT_CONNECTTIMEOUT_MS(3)\fP
        !            42: are set, the value set last will be used.
        !            43: .SH DEFAULT
        !            44: 300000
        !            45: .SH PROTOCOLS
        !            46: All
        !            47: .SH EXAMPLE
        !            48: .nf
        !            49: CURL *curl = curl_easy_init();
        !            50: if(curl) {
        !            51:   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
        !            52: 
        !            53:   /* complete connection within 10000 milliseconds */
        !            54:   curl_easy_setopt(curl, CURLOPT_CONNECTTIMEOUT_MS, 10000L);
        !            55: 
        !            56:   curl_easy_perform(curl);
        !            57: }
        !            58: .fi
        !            59: .SH AVAILABILITY
        !            60: Always
        !            61: .SH RETURN VALUE
        !            62: Returns CURLE_OK
        !            63: .SH "SEE ALSO"
        !            64: .BR CURLOPT_CONNECTTIMEOUT "(3), "
        !            65: .BR CURLOPT_TIMEOUT "(3), " CURLOPT_LOW_SPEED_LIMIT "(3), "