aboutsummaryrefslogtreecommitdiffstats
path: root/erts/doc
diff options
context:
space:
mode:
authorMicael Karlberg <[email protected]>2018-07-11 11:49:58 +0200
committerMicael Karlberg <[email protected]>2018-09-18 14:50:18 +0200
commit9b5560dbe50c377c8fc9b6a0c0c7b6c2dcf9f0de (patch)
tree9c287b6bf5ab7b9ac44752844375fe23346a128a /erts/doc
parent04524794d5e1f80a33f48201e5c14de8c396c30e (diff)
downloadotp-9b5560dbe50c377c8fc9b6a0c0c7b6c2dcf9f0de.tar.gz
otp-9b5560dbe50c377c8fc9b6a0c0c7b6c2dcf9f0de.tar.bz2
otp-9b5560dbe50c377c8fc9b6a0c0c7b6c2dcf9f0de.zip
[socket-doc-nif] Preliminary socket option table
Added a commented out (preliminary) table in the getopt function for the socket level. The table is not included (atleast) in the man page, so there is no point in including it yet. But since its table(s) of all socket options (one for each level) we need comprehensive tables "somewhere", but where... OTP-14831
Diffstat (limited to 'erts/doc')
-rw-r--r--erts/doc/src/socket.xml47
1 files changed, 47 insertions, 0 deletions
diff --git a/erts/doc/src/socket.xml b/erts/doc/src/socket.xml
index 6f116abca9..2681910a72 100644
--- a/erts/doc/src/socket.xml
+++ b/erts/doc/src/socket.xml
@@ -119,6 +119,9 @@
<datatype>
<name name="ip_tos_flag"/>
</datatype>
+ <datatype>
+ <name name="ip_mreq"/>
+ </datatype>
</datatypes>
<funcs>
@@ -194,6 +197,50 @@
<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>
+
+ <!--
+ We need these tables (one for each level) somewhere,
+ but they don't work here, so where?
+
+ <p>Socket level options: </p>
+ <table>
+ <row>
+ <cell><em>Option Name</em></cell>
+ <cell><em>Value Type</em></cell>
+ <cell><em>Set</em></cell>
+ <cell><em>Get</em></cell>
+ <cell><em>Other</em></cell>
+ </row>
+ <row>
+ <cell>acceptcon</cell>
+ <cell>boolean()</cell>
+ <cell>no</cell>
+ <cell>yes</cell>
+ <cell>none</cell>
+ </row>
+ <row>
+ <cell>broadcast</cell>
+ <cell>boolean()</cell>
+ <cell>yes</cell>
+ <cell>yes</cell>
+ <cell>dgram</cell>
+ </row>
+ <row>
+ <cell>debug</cell>
+ <cell>integer()</cell>
+ <cell>yes</cell>
+ <cell>yes</cell>
+ <cell>may require admin capability</cell>
+ </row>
+ <row>
+ <cell>domain</cell>
+ <cell>domain()</cell>
+ <cell>no</cell>
+ <cell>yes</cell>
+ <cell>none</cell>
+ </row>
+ </table>
+ -->
</desc>
</func>