diff options
| author | Micael Karlberg <[email protected]> | 2019-05-17 12:12:02 +0200 |
|---|---|---|
| committer | Micael Karlberg <[email protected]> | 2019-05-29 13:47:40 +0200 |
| commit | 3e2c3eec258b1ea13affe91db0451f3737983306 (patch) | |
| tree | aa89c07f2733256f39c47546bd2a863e912def92 /erts/doc/src | |
| parent | 5345f3d6fcb78acbe65803109f035cc979ad2199 (diff) | |
| download | otp-3e2c3eec258b1ea13affe91db0451f3737983306.tar.gz otp-3e2c3eec258b1ea13affe91db0451f3737983306.tar.bz2 otp-3e2c3eec258b1ea13affe91db0451f3737983306.zip | |
[esock|doc] Updated accoring to handling of Unix Domain socket
Updated documentation with regard to Unix Domain sockets.
OTP-15822
Diffstat (limited to 'erts/doc/src')
| -rw-r--r-- | erts/doc/src/socket.xml | 21 | ||||
| -rw-r--r-- | erts/doc/src/socket_usage.xml | 2 |
2 files changed, 14 insertions, 9 deletions
diff --git a/erts/doc/src/socket.xml b/erts/doc/src/socket.xml index 343b61d4aa..9b34bf1df1 100644 --- a/erts/doc/src/socket.xml +++ b/erts/doc/src/socket.xml @@ -373,19 +373,24 @@ <name name="open" arity="4" since="OTP 22.0"/> <fsummary>Create an endpoint for communication.</fsummary> <desc> - <p>Creates an endpoint (socket) for communication.</p> - <p>For some <c>types</c> there is a default protocol, which will - be used if no protocol is specified: </p> + <p>Creates an endpoint (socket) for communication.</p> - <list> - <item><p><c>stream</c>: <c>tcp</c></p></item> - <item><p><c>dgram</c>: <c>udp</c></p></item> - <item><p><c>seqpacket</c>: <c>sctp</c></p></item> - </list> + <p>For some <c>types</c> there is a default protocol, + indicated by <c>default</c>, which it <em>may</em> be + possible to specify. + And for <c>Domain = local</c>, if a protocol <em>is</em> pecified, + it <em>must</em> be <c>default</c>. </p> <p>The <c>Extra</c> argument is intended for "obscure" options. Currently the only supported option is <c>netns</c>, which is only supported on the linux platform.</p> + + <note> + <p>It may not be possible to specify the default protocol (except + when <c>Domain = local</c>). We need to be able to retreive + the resulting protocol, which is <em>not</em> possble on all + platforms. </p> + </note> </desc> </func> diff --git a/erts/doc/src/socket_usage.xml b/erts/doc/src/socket_usage.xml index e0f006e618..4b3872d7e3 100644 --- a/erts/doc/src/socket_usage.xml +++ b/erts/doc/src/socket_usage.xml @@ -205,7 +205,7 @@ <cell>protocol()</cell> <cell>no</cell> <cell>yes</cell> - <cell>none</cell> + <cell><em>Not</em> on (some) Darwin (for instance)</cell> </row> <row> <cell>rcvbuf</cell> |