diff options
| author | Micael Karlberg <[email protected]> | 2019-05-02 15:08:00 +0200 |
|---|---|---|
| committer | Micael Karlberg <[email protected]> | 2019-05-29 18:41:30 +0200 |
| commit | 64c4668a65195283c7dbc24a677f8d3d46ac5513 (patch) | |
| tree | 8bf4ce00ef8ae27af2e50f45949ef54b1d3e207d /erts/doc/src/socket.xml | |
| parent | 50620e6a44a9e0dc32d51a436b0cc05c44884d1b (diff) | |
| download | otp-64c4668a65195283c7dbc24a677f8d3d46ac5513.tar.gz otp-64c4668a65195283c7dbc24a677f8d3d46ac5513.tar.bz2 otp-64c4668a65195283c7dbc24a677f8d3d46ac5513.zip | |
[esock|doc] Update with regard to the new select returns
Diffstat (limited to 'erts/doc/src/socket.xml')
| -rw-r--r-- | erts/doc/src/socket.xml | 30 |
1 files changed, 23 insertions, 7 deletions
diff --git a/erts/doc/src/socket.xml b/erts/doc/src/socket.xml index f9dd9575f4..48e91e93a7 100644 --- a/erts/doc/src/socket.xml +++ b/erts/doc/src/socket.xml @@ -47,24 +47,40 @@ <seealso marker="#recv_async"><c>recv/3</c></seealso> function with Timeout set to <c>nowait</c> (<c>recv(Sock, 0, nowait)</c>) when there is actually nothing to read, it will return with - <c>{ok, SelectInfo}</c>. When data eventually arrives a 'select' message - will be sent to the caller: + <c>{ok, </c> + <seealso marker="#type-select_info"><c>SelectInfo</c></seealso><c>}</c>. + When data eventually arrives a 'select' message + will be sent to the caller: </p> + <!-- <list type="ordered"> <item><c>{'$socket', Sock, select, Info}</c></item> </list> - The caller can now make another + --> + <taglist> + <!-- NOTE THAT THE EMPTY TAG IS INTENTIONAL --> + <tag></tag> + <item><c>{'$socket', Sock, select, Info}</c></item> + </taglist> + <p>The caller can now 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).</p> <p>Another message the user must be prepared for (when making asynchronous - calls) is the <c>abort</c> message: + calls) is the <c>abort</c> message:</p> + <!-- <list type="ordered"> - <item><c>{'$socket', Sock, abort, Reason}</c></item> + <item><c>{'$socket', Sock, abort, Info}</c></item> </list> - This message indicates + --> + <taglist> + <!-- NOTE THAT THE EMPTY TAG IS INTENTIONAL --> + <tag></tag> + <item><c>{'$socket', Sock, abort, Info}</c></item> + </taglist> + <p>This message indicates that the (asynchronous) operation has been aborted. If, for instance, the socket has been - closed (by another process), <c>Reason</c> will be <c>{Ref, closed}</c>. </p> + closed (by another process), <c>Info</c> will be <c>{Ref, closed}</c>. </p> </note> <note> <p>There is currently <em>no</em> support for Windows. </p> |