diff options
| author | Micael Karlberg <[email protected]> | 2019-05-06 10:44:07 +0200 |
|---|---|---|
| committer | Micael Karlberg <[email protected]> | 2019-05-29 18:45:38 +0200 |
| commit | 88a1140f46b47e8a3526a7239f343ca344e9a3e1 (patch) | |
| tree | b87f5a7db31cd3296f3e5f1487fc4e49b2e8d81f | |
| parent | 27e7c94902e211276318652eb5d83ea18e5e70fd (diff) | |
| download | otp-88a1140f46b47e8a3526a7239f343ca344e9a3e1.tar.gz otp-88a1140f46b47e8a3526a7239f343ca344e9a3e1.tar.bz2 otp-88a1140f46b47e8a3526a7239f343ca344e9a3e1.zip | |
[esock|doc] Make select_ref opaque
OTP-15731
| -rw-r--r-- | erts/doc/src/socket.xml | 20 | ||||
| -rw-r--r-- | erts/preloaded/ebin/socket.beam | bin | 74796 -> 74796 bytes | |||
| -rw-r--r-- | erts/preloaded/src/socket.erl | 2 |
3 files changed, 7 insertions, 15 deletions
diff --git a/erts/doc/src/socket.xml b/erts/doc/src/socket.xml index 48e91e93a7..47e84090ee 100644 --- a/erts/doc/src/socket.xml +++ b/erts/doc/src/socket.xml @@ -51,15 +51,10 @@ <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> - --> <taglist> <!-- NOTE THAT THE EMPTY TAG IS INTENTIONAL --> <tag></tag> - <item><c>{'$socket', Sock, select, Info}</c></item> + <item><c>{'$socket', socket(), select, select_ref()}</c></item> </taglist> <p>The caller can now make another call to the recv function and now expect data.</p> @@ -67,20 +62,15 @@ '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:</p> - <!-- - <list type="ordered"> - <item><c>{'$socket', Sock, abort, Info}</c></item> - </list> - --> <taglist> <!-- NOTE THAT THE EMPTY TAG IS INTENTIONAL --> <tag></tag> - <item><c>{'$socket', Sock, abort, Info}</c></item> + <item><c>{'$socket', socket(), 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>Info</c> will be <c>{Ref, closed}</c>. </p> + If, for instance, the socket has been closed (by another process), + <c>Info</c> will be <c>{select_ref(), closed}</c>. </p> </note> <note> <p>There is currently <em>no</em> support for Windows. </p> @@ -111,6 +101,8 @@ </datatype> <datatype> <name name="select_ref"/> + <desc><p>A reference that uniquely identifies the (select) operation.</p> + </desc> </datatype> <datatype> <name name="select_info"/> diff --git a/erts/preloaded/ebin/socket.beam b/erts/preloaded/ebin/socket.beam Binary files differindex fb4d9850e5..0f438e4ca9 100644 --- a/erts/preloaded/ebin/socket.beam +++ b/erts/preloaded/ebin/socket.beam diff --git a/erts/preloaded/src/socket.erl b/erts/preloaded/src/socket.erl index 60f162d37d..0b1b49653c 100644 --- a/erts/preloaded/src/socket.erl +++ b/erts/preloaded/src/socket.erl @@ -592,7 +592,7 @@ -type select_tag() :: atom(). --type select_ref() :: reference(). +-opaque select_ref() :: reference(). -record(select_info, {tag :: select_tag(), ref :: select_ref()}). |