aboutsummaryrefslogtreecommitdiffstats
path: root/erts/doc/src/socket.xml
diff options
context:
space:
mode:
authorMicael Karlberg <[email protected]>2019-02-12 15:18:07 +0100
committerMicael Karlberg <[email protected]>2019-02-22 19:45:53 +0100
commit2b268fb6ac18956a3d5d55eea57fdc461d5ef7bf (patch)
tree800621865cd2909cdf399fb5a669d850e95daaf7 /erts/doc/src/socket.xml
parentdbb88c285ee0590b736980f063e1d62e8d598953 (diff)
downloadotp-2b268fb6ac18956a3d5d55eea57fdc461d5ef7bf.tar.gz
otp-2b268fb6ac18956a3d5d55eea57fdc461d5ef7bf.tar.bz2
otp-2b268fb6ac18956a3d5d55eea57fdc461d5ef7bf.zip
[socket|doc] Fixed links and stuff
Corrected linking references (links) to functions. Also added links from getopt/setopt functions to the users guide. Also added some comments to the socket module regarding open with (ready made) descriptor (which is not yet supported). OTP-14831
Diffstat (limited to 'erts/doc/src/socket.xml')
-rw-r--r--erts/doc/src/socket.xml26
1 files changed, 22 insertions, 4 deletions
diff --git a/erts/doc/src/socket.xml b/erts/doc/src/socket.xml
index 56737b1a8f..8a68ee3e90 100644
--- a/erts/doc/src/socket.xml
+++ b/erts/doc/src/socket.xml
@@ -4,7 +4,7 @@
<erlref>
<header>
<copyright>
- <year>2018</year><year>2018</year>
+ <year>2018</year><year>2019</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -55,7 +55,7 @@
<datatype>
<name>socket()</name>
<desc><p>As returned by
- <seealso marker="#open/1"><c>open/2,3,4</c></seealso> and
+ <seealso marker="#open/2"><c>open/2,3,4</c></seealso> and
<seealso marker="#accept/1"><c>accept/1,2</c></seealso>.</p>
</desc>
</datatype>
@@ -305,6 +305,10 @@
on what kind of socket it is (<c>domain</c>, <c>type</c> and
<c>protocol</c>).</p>
+ See the
+ <seealso marker="socket_usage#socket_options">socket options</seealso>
+ chapter of the users guide for more info.
+
<note><p>Not all options are valid on all platforms. That is,
even if "we" support an option, that does not mean that the
underlying OS does.</p></note>
@@ -324,6 +328,10 @@
using "native mode", it is *currently* up to the caller to
know how to interpret the result.</p>
+ See the
+ <seealso marker="socket_usage#socket_options">socket options</seealso>
+ chapter of the users guide for more info.
+
<note><p>Not all options are valid on all platforms. That is,
even if "we" support an option, that does not mean that the
underlying OS does.</p></note>
@@ -398,7 +406,8 @@
how much we want to read, it returns when we get a message.</p>
<p>The <c>BufSz</c> argument basically defines the size of the
receive buffer. By setting the value to zero (0), the configured
- size (setopt with <c>Level</c> = <c>otp</c>) is used.</p>
+ size (setopt with <c>Level</c> = <c>otp</c> and <c>Key</c> = <c>rcvbuf</c>)
+ is used.</p>
<p>It may be impossible to know what (buffer) size is appropriate
"in advance", and in those cases it may be convenient to use the
(recv) 'peek' flag. When this flag is provided, the message is *not*
@@ -427,7 +436,8 @@
<p>The <c>BufSz</c> argument basically defines the size of the
receive buffer. By setting the value to zero (0), the configured
- size (setopt with <c>Level</c> = <c>otp</c>) is used.</p>
+ size (setopt with <c>Level</c> = <c>otp</c> and <c>Key</c> = <c>rcvbuf</c>)
+ is used.</p>
<p>The <c>CtrlSz</c> argument basically defines the size of the
receive buffer for the control messages.
@@ -503,6 +513,10 @@
what kind of socket it is (<c>domain</c>, <c>type</c> and
<c>protocol</c>).</p>
+ See the
+ <seealso marker="socket_usage#socket_options">socket options</seealso>
+ chapter of the users guide for more info.
+
<note><p>Not all options are valid on all platforms. That is,
even if "we" support an option, that does not mean that the
underlying OS does.</p></note>
@@ -522,6 +536,10 @@
what kind of socket it is (<c>domain</c>, <c>type</c> and
<c>protocol</c>).</p>
+ See the
+ <seealso marker="socket_usage#socket_options">socket options</seealso>
+ chapter of the users guide for more info.
+
<note><p>Not all options are valid on all platforms. That is,
even if "we" support an option, that does not mean that the
underlying OS does.</p></note>