Debian Codegraph @

deps/curl/docs/libcurl/opts/CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS.3

raw
1 .\" **************************************************************************
2 .\" * _ _ ____ _
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <[email protected]>, 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_HAPPY_EYEBALLS_TIMEOUT_MS 3 "1 Feb 2018" "libcurl 7.59.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS \- head start for ipv6 for happy eyeballs
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS, long timeout);
30 .SH DESCRIPTION
31 Happy eyeballs is an algorithm that attempts to connect to both IPv4 and IPv6
32 addresses for dual-stack hosts, preferring IPv6 first for \fItimeout\fP
33 milliseconds. If the IPv6 address cannot be connected to within that time then
34 a connection attempt is made to the IPv4 address in parallel. The first
35 connection to be established is the one that is used.
36
37 The range of suggested useful values for \fItimeout\fP is limited. Happy
38 Eyeballs RFC 6555 says "It is RECOMMENDED that connection attempts be paced
39 150-250 ms apart to balance human factors against network load." libcurl
40 currently defaults to 200 ms. Firefox and Chrome currently default to 300 ms.
41 .SH DEFAULT
42 CURL_HET_DEFAULT (currently defined as 200L)
43 .SH EXAMPLE
44 .nf
45 CURL *curl = curl_easy_init();
46 if(curl) {
47 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
48 curl_easy_setopt(curl, CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS, 300L);
49
50 curl_easy_perform(curl);
51
52 /* always cleanup */
53 curl_easy_cleanup(curl);
54 }
55 .fi
56 .SH AVAILABILITY
57 Added in 7.59.0
58 .SH RETURN VALUE
59 Returns CURLE_OK