romenskiy2012/curl
1
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2026-04-15 01:01:41 +03:00
Code Issues Projects Releases Packages Wiki Activity

CURLOPT_CONNECTTIMEOUT*: clarify, document the milliseond version

Browse source 
Provide an explanation in the CURLOPT_CONNECTTIMEOUT_MS page instead of
just referring to the non-MS version.

Closes #13905
This commit is contained in:
Daniel Stenberg 2024-06-07 10:44:28 +02:00
parent 9fb759f9a5
commit 7d934267ab
No known key found for this signature in database
GPG key ID: 5CC908FDB71E12C2
2 changed files with 39 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

21
docs/libcurl/opts/CURLOPT_CONNECTTIMEOUT.md
View file

@ -5,7 +5,6 @@ Title: CURLOPT_CONNECTTIMEOUT
Section: 3
Source: libcurl
See-also:
- CURLOPT_CONNECTTIMEOUT_MS (3)
- CURLOPT_LOW_SPEED_LIMIT (3)
- CURLOPT_MAX_RECV_SPEED_LARGE (3)
- CURLOPT_TIMEOUT (3)
@ -27,22 +26,22 @@ 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.
Pass a long. It sets the maximum time in seconds that you allow the connection
phase to take. This timeout only limits the connection phase, it has no impact
once libcurl has connected. The connection phase includes the name resolve
(DNS) and all protocol handshakes and negotiations until there is an
established connection with the remote side.
Set this option 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 milliseconds.
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).
The connection timeout 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 connection

34
docs/libcurl/opts/CURLOPT_CONNECTTIMEOUT_MS.md
View file

@ -5,9 +5,9 @@ Title: CURLOPT_CONNECTTIMEOUT_MS
Section: 3
Source: libcurl
See-also:
- CURLOPT_CONNECTTIMEOUT (3)
- CURLOPT_LOW_SPEED_LIMIT (3)
- CURLOPT_TIMEOUT (3)
- CURLOPT_MAX_RECV_SPEED_LARGE (3)
- CURLOPT_TIMEOUT_MS (3)
Protocol:
- All
---
@ -27,10 +27,34 @@ CURLcode curl_easy_setopt(CURL *handle, CURLOPT_CONNECTTIMEOUT_MS,
# DESCRIPTION
Pass a long. It should contain the maximum time in milliseconds that you allow
the connection phase to the server to take.
Pass a long. It sets the maximum time in milliseconds that you allow the
connection phase to take. This timeout only limits the connection phase, it
has no impact once libcurl has connected. The connection phase includes the
name resolve (DNS) and all protocol handshakes and negotiations until there is
an established connection with the remote side.
See CURLOPT_CONNECTTIMEOUT(3) for details.
Set this option to zero to switch to the default built-in connection timeout -
300 seconds. See also the CURLOPT_TIMEOUT_MS(3) option.
CURLOPT_CONNECTTIMEOUT(3) is the same function but set in seconds.
If both CURLOPT_CONNECTTIMEOUT(3) and CURLOPT_CONNECTTIMEOUT_MS(3) are set,
the value set last is used.
The connection timeout is included in the general all-covering
CURLOPT_TIMEOUT_MS(3):
With CURLOPT_CONNECTTIMEOUT_MS(3) set to 3000 and CURLOPT_TIMEOUT_MS(3) set to
5000, the operation can never last longer than 5000 milliseconds, and the
connection phase cannot last longer than 3000 milliseconds.
With CURLOPT_CONNECTTIMEOUT_MS(3) set to 4000 and CURLOPT_TIMEOUT_MS(3) set to
2000, the operation can never last longer than 2000 milliseconds. Including
the connection phase.
This option may cause libcurl to use the SIGALRM signal to timeout system
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