diff options
| author | Micael Karlberg <bmk@erlang.org> | 2021-07-15 15:15:48 +0200 |
|---|---|---|
| committer | Micael Karlberg <bmk@erlang.org> | 2021-07-29 12:50:18 +0200 |
| commit | e5d35e2a12efae42bdab5155fb220f81d7f53554 (patch) | |
| tree | ba1411453ad0969843d310db1488ca53283394c8 /lib/kernel/doc/src/inet.xml | |
| parent | 6f2846527560cb7d368534296599bce144f6e053 (diff) | |
| download | erlang-e5d35e2a12efae42bdab5155fb220f81d7f53554.tar.gz | |
[kernel|gen-udp-socket|doc] Add preliminary documentation
Add note about 'inet-backend' and the currently only
difference to "standard" (=port) gen_udp.
OTP-17410
Diffstat (limited to 'lib/kernel/doc/src/inet.xml')
| -rw-r--r-- | lib/kernel/doc/src/inet.xml | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml index 7d38e39ae1..ed21bac53a 100644 --- a/lib/kernel/doc/src/inet.xml +++ b/lib/kernel/doc/src/inet.xml @@ -985,6 +985,7 @@ get_tcpi_sacked(Sock) -> mode with values of <c>N</c> appropriate for the application provides flow control. The other side cannot send faster than the receiver can read.</p> + <marker id="option-broadcast"></marker> </item> <tag><c>{broadcast, Boolean}</c> (UDP sockets)</tag> <item> @@ -1393,6 +1394,7 @@ setcap cap_sys_admin,cap_sys_ptrace,cap_dac_read_search+epi beam.smp</code> option <c>packet_size</c> also guarantees that lines up to the indicated length are accepted and not considered invalid because of internal buffer limitations.</p> + <marker id="option-line_delimiter"></marker> </item> <tag><c>{line_delimiter, Char}</c>(TCP/IP sockets)</tag> <item> @@ -1402,6 +1404,7 @@ setcap cap_sys_admin,cap_sys_ptrace,cap_dac_read_search+epi beam.smp</code> <tag><c>{raw, Protocol, OptionNum, ValueBin}</c></tag> <item> <p>See below.</p> + <marker id="option-read_packets"></marker> </item> <tag><c>{read_packets, Integer}</c>(UDP sockets)</tag> <item> @@ -1413,6 +1416,7 @@ setcap cap_sys_admin,cap_sys_ptrace,cap_dac_read_search+epi beam.smp</code> Defaults to <c>5</c>. If this parameter is set too high, the system can become unresponsive because of UDP packet flooding.</p> + <marker id="option-recbuf"></marker> </item> <tag><c>{recbuf, Size}</c></tag> <item> |