Commit dd027c80 authored by Jay Satiro's avatar Jay Satiro
Browse files

lib: CURLOPT_HAPPY_EYEBALLS_TIMEOUT => CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS 

- In keeping with the naming of our other connect timeout options rename
  CURLOPT_HAPPY_EYEBALLS_TIMEOUT to CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS.

This change adds the _MS suffix since the option expects milliseconds.
This is more intuitive for our users since other connect timeout options
that expect milliseconds use _MS such as CURLOPT_TIMEOUT_MS,
CURLOPT_CONNECTTIMEOUT_MS, CURLOPT_ACCEPTTIMEOUT_MS.

The tool option already uses an -ms suffix, --happy-eyeballs-timeout-ms.

Follow-up to 2427d94c which added the lib and tool option yesterday.

Ref: https://github.com/curl/curl/pull/2260
parent de97b5fc

RELEASE-NOTES

+1 −1
Original line number Diff line number Diff line
@@ -11,7 +11,7 @@ This release includes the following changes: 
 o curl: add --proxy-pinnedpubkey [10]

 o added: CURLOPT_TIMEVALUE_LARGE and CURLINFO_FILETIME_T [13]

 o CURLOPT_RESOLVE: Add support for multiple IP addresses per entry [37]

 o Add option CURLOPT_HAPPY_EYEBALLS_TIMEOUT [37]

 o Add option CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS [37]

 o Add new tool option --happy-eyeballs-timeout-ms [37]



This release includes the following bugfixes:

docs/libcurl/curl_easy_setopt.3

+2 −2
Original line number Diff line number Diff line
@@ -464,6 +464,8 @@ Bind name resolves to this IP6 address. See \fICURLOPT_DNS_LOCAL_IP6(3)\fP 
Preferred DNS servers. See \fICURLOPT_DNS_SERVERS(3)\fP

.IP CURLOPT_ACCEPTTIMEOUT_MS

Timeout for waiting for the server's connect back to be accepted. See \fICURLOPT_ACCEPTTIMEOUT_MS(3)\fP

.IP CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS

Timeout for happy eyeballs. See \fICURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS(3)\fP

.SH SSL and SECURITY OPTIONS

.IP CURLOPT_SSLCERT

Client cert. See \fICURLOPT_SSLCERT(3)\fP
@@ -577,8 +579,6 @@ Mode for creating new remote directories. See \fICURLOPT_NEW_DIRECTORY_PERMS(3)\ 
.SH TELNET OPTIONS

.IP CURLOPT_TELNETOPTIONS

TELNET options. See \fICURLOPT_TELNETOPTIONS(3)\fP

.IP CURLOPT_HAPPY_EYEBALLS_TIMEOUT

Timeout for happy eyeballs. See \fICURLOPT_HAPPY_EYEBALLS_TIMEOUT(3)\fP

.SH RETURN VALUE

\fICURLE_OK\fP (zero) means that the option was set properly, non-zero means an

error occurred as \fI<curl/curl.h>\fP defines. See the \fIlibcurl-errors(3)\fP

docs/libcurl/opts/CURLOPT_HAPPY_EYEBALLS_TIMEOUT.3→docs/libcurl/opts/CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS.3

+4 −4
Original line number Diff line number Diff line
@@ -20,13 +20,13 @@ 
.\" *

.\" **************************************************************************

.\"

.TH CURLOPT_HAPPY_EYEBALLS_TIMEOUT 3 "1 Feb 2018" "libcurl 7.59.0" "curl_easy_setopt options"

.TH CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS 3 "1 Feb 2018" "libcurl 7.59.0" "curl_easy_setopt options"

.SH NAME

CURLOPT_HAPPY_EYEBALLS_TIMEOUT \- head start for ipv6 for happy eyeballs

CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS \- head start for ipv6 for happy eyeballs

.SH SYNOPSIS

#include <curl/curl.h>



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

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

.SH DESCRIPTION

Happy eyeballs is an algorithm that attempts to connect to both IPv4 and IPv6

addresses for dual-stack hosts, preferring IPv6 first for \fItimeout\fP
@@ -45,7 +45,7 @@ CURL_HET_DEFAULT (currently defined as 200L) 
CURL *curl = curl_easy_init();

if(curl) {

  curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");

  curl_easy_setopt(curl, CURLOPT_HAPPY_EYEBALLS_TIMEOUT, 300L);

  curl_easy_setopt(curl, CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS, 300L);



  curl_easy_perform(curl);

docs/libcurl/opts/Makefile.inc

+1 −1
Original line number Diff line number Diff line
@@ -136,7 +136,7 @@ man_MANS = \ 
  CURLOPT_FTP_USE_EPSV.3                        \

  CURLOPT_FTP_USE_PRET.3                        \

  CURLOPT_GSSAPI_DELEGATION.3                   \

  CURLOPT_HAPPY_EYEBALLS_TIMEOUT.3              \

  CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS.3           \

  CURLOPT_HEADER.3                              \

  CURLOPT_HEADERDATA.3                          \

  CURLOPT_HEADERFUNCTION.3                      \

docs/libcurl/symbols-in-versions

+1 −1
Original line number Diff line number Diff line
@@ -403,7 +403,7 @@ CURLOPT_FTP_USE_EPRT 7.10.5 
CURLOPT_FTP_USE_EPSV            7.9.2

CURLOPT_FTP_USE_PRET            7.20.0

CURLOPT_GSSAPI_DELEGATION       7.22.0

CURLOPT_HAPPY_EYEBALLS_TIMEOUT  7.59.0

CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS 7.59.0

CURLOPT_HEADER                  7.1

CURLOPT_HEADERDATA              7.10

CURLOPT_HEADERFUNCTION          7.7.2