aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRaimo Niskanen <raimo@erlang.org>2013-11-18 15:55:32 +0100
committerRaimo Niskanen <raimo@erlang.org>2013-11-19 14:21:03 +0100
commitb4d7911ac364eb913d89ff459a8354a1b3983416 (patch)
tree1ccfeec5290f53ec393db127e093d8049225af8b
parent0a41cdc148fd30e67a9a9a34e5e9c2a2a523f80c (diff)
downloadotp-b4d7911ac364eb913d89ff459a8354a1b3983416.tar.gz
otp-b4d7911ac364eb913d89ff459a8354a1b3983416.tar.bz2
otp-b4d7911ac364eb913d89ff459a8354a1b3983416.zip
Document
-rw-r--r--lib/kernel/doc/src/inet.xml76
1 files changed, 76 insertions, 0 deletions
diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml
index fd62f778a2..c09cb6a1ef 100644
--- a/lib/kernel/doc/src/inet.xml
+++ b/lib/kernel/doc/src/inet.xml
@@ -435,6 +435,46 @@ fe80::204:acff:fe17:bf38
</desc>
</func>
<func>
+ <name name="peernames" arity="1"/>
+ <fsummary>
+ Return all address/port numbers for the other end of a connection
+ </fsummary>
+ <desc>
+ <p>
+ The same as
+ <seealso marker="#peernames/2">
+ <c>peernames(<anno>Socket</anno>, 0)</c>
+ </seealso>.
+ Note that this function's behaviour for an SCTP
+ one-to-many style socket is not defined by the SCTP Socket API.
+ </p>
+ </desc>
+ </func>
+ <func>
+ <name name="peernames" arity="2"/>
+ <fsummary>
+ Return all address/port numbers for the other end of a connection
+ </fsummary>
+ <desc>
+ <p>
+ Returns a list of all address/port number pairs for the other end
+ of a socket's association <c><anno>Assoc</anno></c>.
+ </p>
+ <p>
+ This function can return multiple addresses for multihomed
+ sockets such as SCTP sockets. For other sockets it does the
+ same as <seealso marker="#peername/1">peername/1</seealso>.
+ </p>
+ <p>
+ Note that the <c><anno>Assoc</anno></c> parameter
+ is by the SCTP Socket API defined to be ignored for
+ one-to-one style sockets. What the special value <c>0</c>
+ means hence its behaviour for one-to-many style sockets
+ is unfortunately not defined.
+ </p>
+ </desc>
+ </func>
+ <func>
<name name="port" arity="1"/>
<fsummary>Return the local port number for a socket</fsummary>
<desc>
@@ -449,6 +489,42 @@ fe80::204:acff:fe17:bf38
</desc>
</func>
<func>
+ <name name="socknames" arity="1"/>
+ <fsummary>Return all local address/port numbers for a socket</fsummary>
+ <desc>
+ <p>
+ The same as
+ <seealso marker="#socknames/2">
+ <c>socknames(<anno>Socket</anno>, 0)</c>
+ </seealso>.
+ </p>
+ </desc>
+ </func>
+ <func>
+ <name name="socknames" arity="2"/>
+ <fsummary>Return all local address/port numbers for a socket</fsummary>
+ <desc>
+ <p>
+ Returns a list of all local address/port number pairs for a socket
+ for the given association <c><anno>Assoc</anno></c>.
+ </p>
+ <p>
+ This function can return multiple addresses for multihomed
+ sockets such as SCTP sockets. For other sockets it does the
+ same as <seealso marker="#sockname/1">sockname/1</seealso>.
+ </p>
+ <p>
+ Note that the <c><anno>Assoc</anno></c> parameter
+ is by the SCTP Socket API defined to be ignored for
+ one-to-one style sockets. For one-to-many style sockets
+ the special value <c>0</c> is defined to mean that
+ the returned addresses shall be without regard to any
+ particular association. How different SCTP implementations
+ interprets this varies somewhat.
+ </p>
+ </desc>
+ </func>
+ <func>
<name name="setopts" arity="2"/>
<fsummary>Set one or more options for a socket</fsummary>
<type name="socket_setopt"/>