diff options
| author | Micael Karlberg <[email protected]> | 2019-04-24 14:48:24 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2019-04-24 14:48:24 +0200 |
| commit | c302bd7493179e62ef0c3a5e1f9b19ed895ec5e1 (patch) | |
| tree | 2a0ecf8150f44635cb5a68b815a2f78ed02fea38 /lib/kernel/doc | |
| parent | ae53f331a31e6b56382f7b0a791a6f3644542a6a (diff) | |
| parent | 4a4e35f0b59a8496589124cc9128fe3b44c70962 (diff) | |
| download | otp-c302bd7493179e62ef0c3a5e1f9b19ed895ec5e1.tar.gz otp-c302bd7493179e62ef0c3a5e1f9b19ed895ec5e1.tar.bz2 otp-c302bd7493179e62ef0c3a5e1f9b19ed895ec5e1.zip | |
Merge pull request #2191 from elbrujohalcon/elbrujohalcon-gen_tcp-connect-timeout-docs
Add a note about timeouts on gen_tcp:connect/3,4
Diffstat (limited to 'lib/kernel/doc')
| -rw-r--r-- | lib/kernel/doc/src/gen_tcp.xml | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/lib/kernel/doc/src/gen_tcp.xml b/lib/kernel/doc/src/gen_tcp.xml index fc16473393..f8b41d24e2 100644 --- a/lib/kernel/doc/src/gen_tcp.xml +++ b/lib/kernel/doc/src/gen_tcp.xml @@ -259,6 +259,12 @@ do_recv(Sock, Bs) -> <p>The optional <c><anno>Timeout</anno></c> parameter specifies a time-out in milliseconds. Defaults to <c>infinity</c>.</p> <note> + <p>Keep in mind that if the underlying OS <c>connect()</c> call returns + a timeout, <c>gen_tcp:connect</c> will also return a timeout + (i.e. <c>{error, etimedout}</c>), even if a larger <c>Timeout</c> was + specified.</p> + </note> + <note> <p>The default values for options specified to <c>connect</c> can be affected by the Kernel configuration parameter <c>inet_default_connect_options</c>. For details, see |