From b4d7911ac364eb913d89ff459a8354a1b3983416 Mon Sep 17 00:00:00 2001 From: Raimo Niskanen Date: Mon, 18 Nov 2013 15:55:32 +0100 Subject: Document --- lib/kernel/doc/src/inet.xml | 76 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) (limited to 'lib/kernel/doc/src/inet.xml') 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 @@ -434,6 +434,46 @@ fe80::204:acff:fe17:bf38 connection.

+ + + + Return all address/port numbers for the other end of a connection + + +

+ The same as + + peernames(Socket, 0) + . + Note that this function's behaviour for an SCTP + one-to-many style socket is not defined by the SCTP Socket API. +

+ + + + + + Return all address/port numbers for the other end of a connection + + +

+ Returns a list of all address/port number pairs for the other end + of a socket's association Assoc. +

+

+ This function can return multiple addresses for multihomed + sockets such as SCTP sockets. For other sockets it does the + same as peername/1. +

+

+ Note that the Assoc parameter + is by the SCTP Socket API defined to be ignored for + one-to-one style sockets. What the special value 0 + means hence its behaviour for one-to-many style sockets + is unfortunately not defined. +

+ + Return the local port number for a socket @@ -448,6 +488,42 @@ fe80::204:acff:fe17:bf38

Returns the local address and port number for a socket.

 + + + Return all local address/port numbers for a socket + +

+ The same as + + socknames(Socket, 0) + . +

+ + + + + Return all local address/port numbers for a socket + +

+ Returns a list of all local address/port number pairs for a socket + for the given association Assoc. +

+

+ This function can return multiple addresses for multihomed + sockets such as SCTP sockets. For other sockets it does the + same as sockname/1. +

+

+ Note that the Assoc 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 0 is defined to mean that + the returned addresses shall be without regard to any + particular association. How different SCTP implementations + interprets this varies somewhat. +

+ + Set one or more options for a socket -- cgit v1.2.3 From b9278a19e1abdb80d93833773f4b9c431958bdcb Mon Sep 17 00:00:00 2001 From: Raimo Niskanen Date: Mon, 25 Nov 2013 10:13:29 +0100 Subject: Improve documentation --- lib/kernel/doc/src/inet.xml | 60 +++++++++++++++++++++++++++------------------ 1 file changed, 36 insertions(+), 24 deletions(-) (limited to 'lib/kernel/doc/src/inet.xml') diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml index c09cb6a1ef..bc4c68230e 100644 --- a/lib/kernel/doc/src/inet.xml +++ b/lib/kernel/doc/src/inet.xml @@ -430,8 +430,16 @@ fe80::204:acff:fe17:bf38 Return the address and port for the other end of a connection -

Returns the address and port for the other end of a - connection.

+

+ Returns the address and port for the other end of a + connection. +

+

+ Note that for SCTP sockets this function only returns + one of the socket's peer addresses. The function + peernames/1,2 + returns all. +

@@ -441,12 +449,11 @@ fe80::204:acff:fe17:bf38

- The same as - - peernames(Socket, 0) - . + Equivalent to + peernames(Socket, 0). Note that this function's behaviour for an SCTP - one-to-many style socket is not defined by the SCTP Socket API. + one-to-many style socket is not defined by the + SCTP Sockets API Extensions.

@@ -462,12 +469,13 @@ fe80::204:acff:fe17:bf38

This function can return multiple addresses for multihomed - sockets such as SCTP sockets. For other sockets it does the - same as peername/1. + sockets such as SCTP sockets. For other sockets it + returns a one element list.

- Note that the Assoc parameter - is by the SCTP Socket API defined to be ignored for + Note that the Assoc parameter is by the + SCTP Sockets API Extensions + defined to be ignored for one-to-one style sockets. What the special value 0 means hence its behaviour for one-to-many style sockets is unfortunately not defined. @@ -486,6 +494,12 @@ fe80::204:acff:fe17:bf38 Return the local address and port number for a socket

Returns the local address and port number for a socket.

+

+ Note that for SCTP sockets this function only returns + one of the socket addresses. The function + socknames/1,2 + returns all. +

@@ -493,10 +507,8 @@ fe80::204:acff:fe17:bf38 Return all local address/port numbers for a socket

- The same as - - socknames(Socket, 0) - . + Equivalent to + socknames(Socket, 0).

@@ -510,17 +522,17 @@ fe80::204:acff:fe17:bf38

This function can return multiple addresses for multihomed - sockets such as SCTP sockets. For other sockets it does the - same as sockname/1. + sockets such as SCTP sockets. For other sockets it + returns a one element list.

- Note that the Assoc 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 0 is defined to mean that - the returned addresses shall be without regard to any - particular association. How different SCTP implementations - interprets this varies somewhat. + Note that the Assoc parameter is by the + SCTP Sockets API Extensions + defined to be ignored for one-to-one style sockets. + For one-to-many style sockets the special value 0 + is defined to mean that the returned addresses shall be + without regard to any particular association. + How different SCTP implementations interprets this varies somewhat.

-- cgit v1.2.3