Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

sctp_getpaddrs(3) [debian man page]

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

sctp_getpaddrs - Returns all peer addresses in an association. SYNOPSIS
#include <sys/types.h> #include <sys/socket.h> #include <netinet/sctp.h> int sctp_getpaddrs(int sd, sctp_assoc_t assoc_id, struct sockaddr **addrs); void sctp_freepaddrs(struct sockaddr *addrs); DESCRIPTION
sctp_getpaddrs returns all peer addresses in an association. On return, addrs will point to a dynamically allocated packed array of sock- addr structures of the appropriate type for each address. The caller should use sctp_freepaddrs 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. sctp_freepaddrs frees all the resources allocated by sctp_getpaddrs. RETURN VALUE
On success, sctp_getpaddrs returns the number of peer addresses in the association. If there is no association on this socket, 0 is returned and the value of *addrs is undefined. On error, sctp_getpaddrs 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_getladdrs(3), sctp_opt_info(3), Linux 2.6 2005-10-25 SCTP_GETPADDRS(3)

Check Out this Related Man Page

sctp_getpaddrs(3SOCKET) 				     Sockets Library Functions					   sctp_getpaddrs(3SOCKET)

sctp_getpaddrs, sctp_freepaddrs - returns all peer addresses on an SCTP association SYNOPSIS
cc [ flag... ] file... -lsocket -lnsl -lsctp [ library... ] #include <sys/types.h> #include <sys/socket.h> #include <netinet/sctp.h> int sctp_getpaddrs(int sock, sctp_assoc_t id, void **addrs, void sctp_freepaddrs(void *addrs); DESCRIPTION
The sctp_getpaddrs() queries the peer addresses in an SCTP association. The sctp_freepaddrs() function releases resources that are allo- cated to hold the addresses. The sctp_getpaddrs() function returns all the peer addresses in the SCTP association identified by 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. If sock is a one-to-one style SCTP socket, id is ignored. The sctp_freepaddrs() function frees the resources allocated by sctp_getpaddrs(). The addrs parameter is the array of addresses allocated by sctp_getpaddrs(). RETURN VALUES
Upon successful completion, the sctp_getpaddrs() 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_getpaddrs() succeeds unless one of the following conditions exist. 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 association identifier for a one-to-many style STP socket. ENOTCONN The specified socket is not connected. 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_freeladdrs(3SOCKET), sctp_getladdrs(3SOCKET), socket(3SOCKET), inet(7P), inet6(7P), ip(7P), ip6(7P)sctp(7P) SunOS 5.10 26 Feb 2004 sctp_getpaddrs(3SOCKET)
Man Page