diff options
| author | Micael Karlberg <bmk@erlang.org> | 2019-11-21 16:42:36 +0100 |
|---|---|---|
| committer | Micael Karlberg <bmk@erlang.org> | 2019-11-21 16:42:36 +0100 |
| commit | 6d0ab3b804468ee619ce18d1759e438f5d564e0c (patch) | |
| tree | c0da692c0d70a375907c02e37e33800325e19ca0 | |
| parent | 0a1b3d9c1dff82d82ce78e4b4cd01acd1bbf2924 (diff) | |
| download | erlang-6d0ab3b804468ee619ce18d1759e438f5d564e0c.tar.gz | |
[esock|doc] Miscellaneous improvements
Various improvements and clarifications.
| -rw-r--r-- | erts/doc/src/socket.xml | 8 | ||||
| -rw-r--r-- | erts/doc/src/socket_usage.xml | 8 |
2 files changed, 8 insertions, 8 deletions
diff --git a/erts/doc/src/socket.xml b/erts/doc/src/socket.xml index 231d79593a..fdc414d684 100644 --- a/erts/doc/src/socket.xml +++ b/erts/doc/src/socket.xml @@ -32,10 +32,10 @@ <module since="OTP 22.0">socket</module> <modulesummary>Socket interface.</modulesummary> <description> - <p>This module provides an API for the socket interface. - It is used to create, delete and manipulate sockets, - send and receive data.</p> - <p>The idea is that it shall be as "close as possible" to the OS + <p>This module provides an API for network socket. + Functions are provided to create, delete and manupilate the sockets + aswell as sending and reciving data on them. </p> + <p>The intent is that it shall be as "close as possible" to the OS level socket interface. The only significant addition is that some of the functions, e.g. <seealso marker="#recv/3"><c>recv/3</c></seealso>, diff --git a/erts/doc/src/socket_usage.xml b/erts/doc/src/socket_usage.xml index c1ec2f747c..e748a34080 100644 --- a/erts/doc/src/socket_usage.xml +++ b/erts/doc/src/socket_usage.xml @@ -69,6 +69,10 @@ </taglist> <p>The caller can then make another call to the recv function and now expect data.</p> + <p>Note that all other users are <em>locked out</em> until the + 'current user' has called the function (recv in this case). So either + immediately call the function or + <seealso marker="socket#cancel/2"><c>cancel</c></seealso>. </p> <p>The user must also be prepared to receive an abort message: </p> <taglist> <!-- NOTE THAT THE EMPTY TAG IS INTENTIONAL --> @@ -79,10 +83,6 @@ for whatever reason (e.g. if the socket is closed "by someone else"). The <c>Info</c> part contains the abort reason (in this case that the socket has been closed <c>Info = {SelectRef, closed}</c>). </p> - <p>Note that all other users are <em>locked out</em> until the - 'current user' has called the function (recv in this case). So either - immediately call the function or - <seealso marker="socket#cancel/2"><c>cancel</c></seealso>. </p> <p>The general form of the 'socket' message is: </p> <taglist> |