diff options
| author | Micael Karlberg <bmk@erlang.org> | 2021-02-26 11:58:48 +0100 |
|---|---|---|
| committer | Micael Karlberg <bmk@erlang.org> | 2021-02-26 11:58:48 +0100 |
| commit | 07e73c479cb0a5bf83509d6c7859773adcb45b56 (patch) | |
| tree | 1301bc77b1e8999665e820abf2772c1bc64aecea /lib/kernel/doc/src/inet.xml | |
| parent | af06b432876f397a07c31ec3080b38f750202f24 (diff) | |
| download | erlang-07e73c479cb0a5bf83509d6c7859773adcb45b56.tar.gz | |
[kernel|gen-tcp-socket|doc] Document option nodelay discrepancy
We do *not* hide that the nodelay option does not work when
used with Unix Domain Sockets when gen_tcp is used with
inet_backend = socket (which it is when used with
inet_backend = inet). This is now documented.
OTP-17156
Diffstat (limited to 'lib/kernel/doc/src/inet.xml')
| -rw-r--r-- | lib/kernel/doc/src/inet.xml | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml index 903f58a1c4..2bf7c1066e 100644 --- a/lib/kernel/doc/src/inet.xml +++ b/lib/kernel/doc/src/inet.xml @@ -1206,12 +1206,16 @@ setcap cap_sys_admin,cap_sys_ptrace,cap_dac_read_search+epi beam.smp</code> <tag><c>binary</c></tag> <item> <p>Received <c>Packet</c> is delivered as a binary.</p> + <marker id="option-nodelay"></marker> </item> <tag><c>{nodelay, Boolean}</c>(TCP/IP sockets)</tag> <item> <p>If <c>Boolean == true</c>, option <c>TCP_NODELAY</c> - is turned on for the socket, which means that also small - amounts of data are sent immediately.</p> + is turned on for the socket, which means that also small + amounts of data are sent immediately.</p> + <p>This option is <em>not</em> supported for + <c>domain = local</c>, but if <c>inet_backend =/= socket</c> + this error will be <em>ignored</em>. </p> </item> <tag><c>{nopush, Boolean}</c>(TCP/IP sockets)</tag> <item> |