aboutsummaryrefslogtreecommitdiffstats
path: root/erts/doc
diff options
context:
space:
mode:
authorMicael Karlberg <[email protected]>2018-09-13 15:44:21 +0200
committerMicael Karlberg <[email protected]>2018-09-18 14:50:18 +0200
commit929ae46220f402d6f36072c46fe27ba39ad48d1b (patch)
treeb51ba588683a452a13603294f3e2990526b30538 /erts/doc
parentee2eadd1c61d4237ee4044260665c82edf559228 (diff)
downloadotp-929ae46220f402d6f36072c46fe27ba39ad48d1b.tar.gz
otp-929ae46220f402d6f36072c46fe27ba39ad48d1b.tar.bz2
otp-929ae46220f402d6f36072c46fe27ba39ad48d1b.zip
[socket-nif] CMsgHdr and various doc related changes
Updated the (send) cmsghdr type and the handling of it (in the nif code). Still not tested! Removed the is_loaded nif function. Tried to get fix the doc build problem (socket.erl *i think*), which causes socket.html generation to fail with: "cannot find module exporting type" To solve this I tried to run dialyzer on preloaded, and ran into problems with enc_setopt_value. Update various specs and types to "solve" this (which did not work). Updated the nif-stub functions to make dialyzer happy.
Diffstat (limited to 'erts/doc')
-rw-r--r--erts/doc/src/socket.xml20
1 files changed, 13 insertions, 7 deletions
diff --git a/erts/doc/src/socket.xml b/erts/doc/src/socket.xml
index b11b68cba5..35f7e8502d 100644
--- a/erts/doc/src/socket.xml
+++ b/erts/doc/src/socket.xml
@@ -176,11 +176,16 @@
<datatype>
<name name="cmsghdr_type"/>
</datatype>
+ <!--
<datatype>
<name name="cmsghdr_data"/>
</datatype>
+ -->
<datatype>
- <name name="cmsghdr"/>
+ <name name="cmsghdr_recv"/>
+ </datatype>
+ <datatype>
+ <name name="cmsghdr_send"/>
</datatype>
<datatype>
<name name="uint8"/>
@@ -427,7 +432,7 @@
how much we want to read, it returns when we get a message.</p>
<p>The message will be delivered in the form of a <c>msghdr()</c>,
which may contain the source address (if socket not connected),
- a list of <c>cmsghdr()</c> (depends on what socket options have
+ a list of <c>cmsghdr_recv()</c> (depends on what socket options have
been set and what the protocol and platform supports) and
also a set of flags, providing further info about the read . </p>
@@ -466,11 +471,11 @@
<name name="sendmsg" arity="4"/>
<fsummary>Send a message on a socket.</fsummary>
<desc>
- <p>Send a message on a socket. The destination, if needed (socket not
- connected) is provided in the <c>MsgHdr</c>, which also
- contains the message to send, The <c>MsgHdr</c> may also contain
- an list of optional <c>cmsghdr()</c> (depends on what the protocol and
- platform supports).</p>
+ <p>Send a message on a socket. The destination, if needed
+ (socket <em>not</em> connected) is provided in the <c>MsgHdr</c>,
+ which also contains the message to send,
+ The <c>MsgHdr</c> may also contain an list of optional <c>cmsghdr_send()</c>
+ (depends on what the protocol and platform supports).</p>
</desc>
</func>
@@ -492,6 +497,7 @@
<name name="setopt" arity="4" clause_i="5"/>
<name name="setopt" arity="4" clause_i="6"/>
<name name="setopt" arity="4" clause_i="7"/>
+ <name name="setopt" arity="4" clause_i="8"/>
<fsummary>Set options on a socket.</fsummary>
<desc>
<p>Set options on a socket.</p>