SCTP_BINDX(3) BSD Library Functions Manual SCTP_BINDX(3)NAME
sctp_bindx -- bind or unbind an SCTP socket to a list of addresses.
LIBRARY
Standard C Library (libc, -lc)
SYNOPSIS
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/sctp.h>
int
sctp_bindx(int s, struct sockaddr *addrs, int num, int type);
DESCRIPTION
The sctp_bindx() call binds or unbinds a address or a list of addresses to an SCTP endpoint. This allows a user to bind a subset of
addresses. The sctp_bindx() call operates similarly to bind() but allows a list of addresses and also allows a bind or an unbind. The argu-
ment s must be a valid SCTP socket descriptor. The argument addrs is a list of addresses (where the list may be only 1 in length) that the
user wishes to bind or unbind to the socket. The argument type must be one of the following values.
SCTP_BINDX_ADD_ADDR This value indicates that the listed address(es) need to be added to the endpoint.
SCTP_BINDX_DEL_ADDR This value indicates that the listed address(es) need to be removed from the endpoint.
Note that when a user adds or deletes an address to an association if the dynamic address flag net.inet.sctp.auto_asconf is enabled any asso-
ciations in the endpoint will attempt to have the address(es) added dynamically to the existing association.
RETURN VALUES
The call returns 0 on success and -1 upon failure.
ERRORS
The sctp_bindx() function can return the following errors:
[EINVAL] This value is returned if the type field is not one of the allowed values (see above).
[ENOMEM] This value is returned if the number of addresses being added causes a memory allocation failure in the call.
[EBADF] The argument s is not a valid descriptor.
[ENOTSOCK] The argument s is not a socket.
SEE ALSO bind(2), sctp(4)BSD December 15, 2006 BSD
Check Out this Related Man Page
sctp_bindx(3SOCKET) Sockets Library Functions sctp_bindx(3SOCKET)NAME
sctp_bindx - add or remove IP addresses to or from 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_bindx(int sock, void *addrs, int addrcnt, int flags);
DESCRIPTION
The sctp_bindx() function adds or removes addresses to or from an SCTP socket. If sock is an Internet Protocol Version 4 (IPv4) socket,
addrs should be an array of sockaddr_in structures containing IPv4 addresses. If sock is an Internet Protocol Version 6 (IPv6) socket,
addrs should be an array of sockaddr_in6 structures containing IPv6 or IPv4-mapped IPv6 addresses. The addrcnt is the number of array ele-
ments in addrs. The family of the address type is used with addrcnt to determine the size of the array.
The flags parameter is a bitmask that indicates whether addresses are to be added or removed from a socket. The flags parameter is formed
by bitwise OR of zero or more of the following flags:
SCTP_BINDX_ADD_ADDR Indicates that addresses from addrs should be added to the SCTP socket.
SCTP_BINDX_REM_ADDR Indicates that addresses from addrs should be removed from the SCTP socket.
These two flags are mutually exclusive. If flags is formed by a bitwise OR of both SCTP_BINDX_ADD_ADDR and SCTP_BINDX_REM_ADDR, the
sctp_bindx() function will fail.
Prior to calling sctp_bindx() on an SCTP endpoint, the endpoint should be bound using bind(3SOCKET). On a listening socket, a special
INADDR_ANY value for IP or an unspecified address of all zeros for IPv6 can be used in addrs to add all IPv4 or IPv6 addresses on the sys-
tem to the socket. The sctp_bindx() function can also be used to add or remove addresses to or from an established association. In such a
case, messages are exchanged between the SCTP endpoints to update the address lists for that association if both endpoints support dynamic
address reconfiguration.
RETURN VALUES
Upon successful completion, the sctp_bindx() function returns 0. Otherwise, the function returns -1 and sets errno to indicate the error.
ERRORS
The sctp_bindx() call fails under the following conditions.
EBADF The sock argument is an invalid file descriptor.
ENOTSOCK The sock argument is not a socket.
EINVAL One or more of the IPv4 or IPv6 addresses is invalid.
EINVAL The endpoint is not bound.
EINVAL The last address is requested to be removed from an established association.
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), listen(3SOCKET), sctp_freeladdrs(3SOCKET), sctp_freepaddrs(3SOCKET), sctp_getladdrs(3SOCKET),
sctp_getpaddrs(3SOCKET), socket(3SOCKET), inet(7P), inet6(7P), ip(7P), ip6(7P), sctp(7P)SunOS 5.10 05 Mar 2004 sctp_bindx(3SOCKET)