diff options
| author | Lukas Larsson <[email protected]> | 2017-03-28 08:23:01 +0200 |
|---|---|---|
| committer | Lukas Larsson <[email protected]> | 2017-03-28 08:23:01 +0200 |
| commit | 2a24d08dbb9188cb4c3ee07c92ff5c09bba6c5e3 (patch) | |
| tree | 4aba44f2df2104280394e7974efb16649c48d887 /lib/kernel/doc | |
| parent | d91a8a9f324c22c41aae9cad7cd717c4ca2080d2 (diff) | |
| parent | 1b4dedb155a4fe6faf35448c2d119e391204701a (diff) | |
| download | otp-2a24d08dbb9188cb4c3ee07c92ff5c09bba6c5e3.tar.gz otp-2a24d08dbb9188cb4c3ee07c92ff5c09bba6c5e3.tar.bz2 otp-2a24d08dbb9188cb4c3ee07c92ff5c09bba6c5e3.zip | |
Merge branch 'lukas/kernel/gen_tcp_close_docs'
* lukas/kernel/gen_tcp_close_docs:
kernel: Expand gen_tcp:close docs with send text
Diffstat (limited to 'lib/kernel/doc')
| -rw-r--r-- | lib/kernel/doc/src/gen_tcp.xml | 17 | ||||
| -rw-r--r-- | lib/kernel/doc/src/inet.xml | 2 |
2 files changed, 18 insertions, 1 deletions
diff --git a/lib/kernel/doc/src/gen_tcp.xml b/lib/kernel/doc/src/gen_tcp.xml index e97db20062..bef8096aed 100644 --- a/lib/kernel/doc/src/gen_tcp.xml +++ b/lib/kernel/doc/src/gen_tcp.xml @@ -140,6 +140,23 @@ do_recv(Sock, Bs) -> <fsummary>Close a TCP socket.</fsummary> <desc> <p>Closes a TCP socket.</p> + <p>Note that in most implementations of TCP, doing a <c>close</c> does + not guarantee that any data sent is delivered to the recipient before + the close is detected at the remote side. If you want to guarantee + delivery of the data to the recipient there are two common ways to + achieve this.</p> + <list type="ordered"> + <item><p>Use <seealso marker="#shutdown/2"> + <c>gen_tcp:shutdown(Sock, write)</c></seealso> to signal that + no more data is to be sent and wait for the read side of the + socket to be closed.</p> + </item> + <item><p>Use the socket option <seealso marker="inet#packet"> + <c>{packet, N}</c></seealso> (or something similar) to make + it possible for the receiver to close the connection when it + knowns it has received all the data.</p> + </item> + </list> </desc> </func> diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml index d557efb6a8..076e50cd10 100644 --- a/lib/kernel/doc/src/inet.xml +++ b/lib/kernel/doc/src/inet.xml @@ -913,7 +913,7 @@ setcap cap_sys_admin,cap_sys_ptrace,cap_dac_read_search+epi beam.smp</code> </item> <tag><c>{packet, PacketType}</c>(TCP/IP sockets)</tag> <item> - <p>Defines the type of packets to use for a socket. + <p><marker id="packet"/>Defines the type of packets to use for a socket. Possible values:</p> <taglist> <tag><c>raw | 0</c></tag> |