sctp_getladdrs(3) [debian man page]

SCTP_GETLADDRS(3)					     Linux Programmer's Manual						 SCTP_GETLADDRS(3)

NAME

       sctp_getladdrs - Returns all locally bound addresses on a socket.

SYNOPSIS

       #include <sys/types.h>
       #include <sys/socket.h>
       #include <netinet/sctp.h>

       int sctp_getladdrs(int sd, sctp_assoc_t assoc_id,
			  struct sockaddr **addrs);

       void sctp_freeladdrs(struct sockaddr *addrs);

DESCRIPTION

       sctp_getladdrs  returns	all  locally  bound  addresses on a socket. On return, addrs will point to a dynamically allocated packed array of
       sockaddr structures of the appropriate type for each local address. The caller should use sctp_freeladdrs to free the memory. Note that the
       in/out parameter addrs must not be NULL.

       If sd is an IPv4 socket, the addresses returned will be all IPv4 addresses. If sd is an IPv6 socket, the addresses returned can be a mix of
       IPv4 or IPv6 addresses.

       For one-to-many style sockets, id specifies the association to query. For one-to-one style sockets, id is ignored.

       If the id field is set to 0, then the locally bound addresses are returned without regard to any particular association.

       sctp_freeladdrs frees all the resources allocated by sctp_getladdrs

RETURN VALUE

       On success, sctp_getladdrs returns the number of local addresses bound to the socket. If the socket is unbound, 0 is returned and the value
       of *addrs is undefined. On error, sctp_getladdrs returns -1 and the value of *addrs is undefined.

SEE ALSO

       sctp(7)	  sctp_bindx(3),   sctp_connectx(3),   sctp_sendmsg(3),   sctp_send(3),   sctp_recvmsg(3),   sctp_peeloff(3),	sctp_getpaddrs(3),
       sctp_opt_info(3),

Linux 2.6							    2005-10-25							 SCTP_GETLADDRS(3)

sctp_getladdrs(3SOCKET) 				     Sockets Library Functions					   sctp_getladdrs(3SOCKET)

NAME

       sctp_getladdrs, sctp_freeladdrs - returns all locally bound addresses on an SCTP socket

SYNOPSIS

       cc [ flag... ] file... -lsocket -lnsl -lsctp [ library... ]
       #include <sys/types.h>
       #include <sys/socket.h>
       #include <netinet/sctp.h>

       int sctp_getladdrs(int sock, sctp_assoc_t id, void **addrs, void sctp_freeladdrs(void *addrs);

DESCRIPTION

       The  sctp_getladdrs()  function	queries addresses to which an SCTP socket is bound. The sctp_freeladdrs() function releases resources that
       are allocated to hold the addresses.

       The sctp_getladdrs() function returns all the locally bound addresses on the SCTP socket sock. On completion addrs points to a  dynamically
       allocated  array  of  sockaddr_in  structures for an Internet Protocol (IPv4) socket or an array of sockaddr_in6 structures for an Internet
       Protocol Version 6 (IPv6) socket. The addrs parameter must not be NULL. For an IPv4 SCTP socket, the addresses returned in the  sockaddr_in
       structures  are	IPv4 addresses. For an IPv6 SCTP socket, the addresses in the sockaddr_in6 structures can be IPv6 addresses or IPv4-mapped
       IPv6 addresses.

       If sock is a one-to-many style SCTP socket, id specifies the association of interest. A value of 0 to id  returns  locally-bound  addresses
       regardless of a particular association. If sock is a one-to-one style SCTP socket, id is ignored.

       The  sctp_freeladdrs()  function frees the resources allocated by sctp_getladdrs(). The addrs parameter is the array of addresses allocated
       by sctp_getladdrs().

RETURN VALUES

       Upon successful completion, the sctp_getladdrs() function returns the number of addresses in  the  addrs  array.  Otherwise,  the  function
       returns -1 and sets errno to indicate the error.

ERRORS

       The sctp_getladdrs() call fails under the following conditions.

       EBADF	       The sock argument is an invalid file descriptor.

       ENOTSOCK        The sock argument is not a socket.

       EINVAL	       The addrs argument is NULL.

       EINVAL	       The id argument is an invalid socket.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Evolving			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       bind(3SOCKET), in.h(3HEAD), libsctp(3LIB), sctp_freepaddrs(3SOCKET), sctp_getpaddrs(3SOCKET), socket(3SOCKET), inet(7P), inet6(7P), ip(7P),
       ip6(7P), sctp(7P)

SunOS 5.10							    05 Mar 2004 					   sctp_getladdrs(3SOCKET)