diff options
| author | Micael Karlberg <[email protected]> | 2019-06-27 12:39:09 +0200 |
|---|---|---|
| committer | Micael Karlberg <[email protected]> | 2019-06-27 12:39:09 +0200 |
| commit | 43939e525330a779301eee28cf5d36710ed0cb07 (patch) | |
| tree | 67a2223afc0e9be71c43b1f8493ba79a8028f03a /erts/doc/src | |
| parent | d8fd1f6267efd29bcc6a41bb33035f4602fea699 (diff) | |
| download | otp-43939e525330a779301eee28cf5d36710ed0cb07.tar.gz otp-43939e525330a779301eee28cf5d36710ed0cb07.tar.bz2 otp-43939e525330a779301eee28cf5d36710ed0cb07.zip | |
[esock|doc] Add documentation for the (socket) info function
Add documentation for the (socket) info function, which (among
other things) return the socket counters. Also typed the
return value (socket_info()).
OTP-15818
Diffstat (limited to 'erts/doc/src')
| -rw-r--r-- | erts/doc/src/socket.xml | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/erts/doc/src/socket.xml b/erts/doc/src/socket.xml index b4e22e86a8..da049b1a7f 100644 --- a/erts/doc/src/socket.xml +++ b/erts/doc/src/socket.xml @@ -112,6 +112,15 @@ <name name="select_info"/> </datatype> <datatype> + <name name="socket_counters"/> + </datatype> + <datatype> + <name name="socket_counter"/> + </datatype> + <datatype> + <name name="socket_info"/> + </datatype> + <datatype> <name name="ip4_address"/> </datatype> <datatype> @@ -456,6 +465,20 @@ </func> <func> + <name name="info" arity="1" since="OTP @OTP-15818@"/> + <fsummary>Get miscellaneous socket info.</fsummary> + <desc> + <p>Get miscellaneous info about the socket.</p> + <p>The function returns a map with each info item as a key-value + binding. It reflects the "current" state of the socket. </p> + <note> + <p>In order to ensure data integrity, mutex'es are taken when + needed. So, do not call this function often. </p> + </note> + </desc> + </func> + + <func> <name name="listen" arity="1" since="OTP 22.0"/> <name name="listen" arity="2" since="OTP 22.0"/> <fsummary>Listen for connections on a socket.</fsummary> |