Sockets Library Functions sctpgetpaddrs(3SOCKET)
NAME
sctpgetpaddrs, sctpfreepaddrs - returns all peer addresses
on an SCTP association
SYNOPSIS
cc [ flag... ] file... -lsocket -lnsl -lsctp [ library... ]
#include
#include
#include
int sctpgetpaddrs(int sock, sctpassoct id, void **addrs);
void sctpfreepaddrs(void *addrs);
DESCRIPTION
The sctpgetpaddrs() queries the peer addresses in an SCTP
association. The sctpfreepaddrs() function releases
resources that are allocated to hold the addresses.
The sctpgetpaddrs() function returns all the peer addresses
in the SCTP association identified by sock. On completion
addrs points to a dynamically allocated array of sockaddrin
structures for an Internet Protocol (IPv4) socket or an
array of sockaddrin6 structures for an Internet Protocol
Version 6 (IPv6) socket. The addrs parameter must not be
NUL. For an IPv4 SCTP socket, the addresses returned in the
sockaddrin structures are IPv4 addresses. For an IPv6 SCTP
socket, the addresses in the sockaddrin6 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 sctpfreepaddrs() function frees the resources allocated
by sctpgetpaddrs(). The addrs parameter is the array of
addresses allocated by sctpgetpaddrs().
RETURN VALUES
Upon successful completion, the sctpgetpaddrs() function
returns the number of addresses in the addrs array. Other-
wise, the function returns -1 and sets errno to indicate the
error.
ERORS
The sctpgetpaddrs() succeeds unless one of the following
conditions exist.
SunOS 5.11 Last change: 23 Jan 2008 1
Sockets Library Functions sctpgetpaddrs(3SOCKET)
EBADF The sock argument is an invalid file descriptor.
ENOTSOCK The sock argument is not a socket.
EINVAL The addrs argument is NUL.
EINVAL The id argument is an invalid association iden-
tifier for a one-to-many style STP socket.
ENOTCON The specified socket is not connected.
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
ATRIBUTE TYPE ATRIBUTE VALUE
Interface Stability Committed
MT-Level Safe
SEE ALSO
bind(3SOCKET), in.h(3HEAD), libsctp(3LIB),
sctpfreeladdrs(3SOCKET), sctpgetladdrs(3SOCKET),
socket(3SOCKET), attributes(5), inet(7P), inet6(7P), ip(7P),
ip6(7P), sctp(7P)
SunOS 5.11 Last change: 23 Jan 2008 2
|