SCTP_PEELOFF(3SOCKET) Sockets Library Functions SCTP_PEELOFF(3SOCKET)
sctp_peeloff - branch off existing association from a one-to-many
SCTP socket to create a one-to-one STP socket
cc [ flag... ] file... -lsocket -lnsl -lsctp [ library... ]
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/sctp.h>
int sctp_peeloff(int sock, sctp_assoc_t id);
The sctp_peeloff() function branches off an existing association from
a one-to-many style SCTP socket into a separate socket file
descriptor. The resulting branched-off socket is a one-to-one style
SCTP socket and is confined to operations allowed on a one-to-one
style SCTP socket.
The sock argument is a one-to-many socket. The association specified
by the id argument is branched off sock.
Upon successful completion, the sctp_peeloff() function returns the
file descriptor that references the branched-off socket. The function
returns -1 if an error occurs.
The sctp_peeloff() function fails under the following conditions.
EOPTNOTSUPP
The sock argument is not a one-to-many style SCTP
socket.
EINVAL
The id is 0 or greater than the maximum number of
associations for sock.
EMFILE
Failure to create a new user file descriptor or file
structure.
See attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Evolving |
+--------------------+-----------------+
|MT-Level | Safe |
+--------------------+-----------------+
in.h(3HEAD), libsctp(3LIB), socket(3SOCKET), sctp(4P)
March 5, 2004 SCTP_PEELOFF(3SOCKET)
NAME
sctp_peeloff - branch off existing association from a one-to-many
SCTP socket to create a one-to-one STP socket
SYNOPSIS
cc [ flag... ] file... -lsocket -lnsl -lsctp [ library... ]
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/sctp.h>
int sctp_peeloff(int sock, sctp_assoc_t id);
DESCRIPTION
The sctp_peeloff() function branches off an existing association from
a one-to-many style SCTP socket into a separate socket file
descriptor. The resulting branched-off socket is a one-to-one style
SCTP socket and is confined to operations allowed on a one-to-one
style SCTP socket.
The sock argument is a one-to-many socket. The association specified
by the id argument is branched off sock.
RETURN VALUES
Upon successful completion, the sctp_peeloff() function returns the
file descriptor that references the branched-off socket. The function
returns -1 if an error occurs.
ERRORS
The sctp_peeloff() function fails under the following conditions.
EOPTNOTSUPP
The sock argument is not a one-to-many style SCTP
socket.
EINVAL
The id is 0 or greater than the maximum number of
associations for sock.
EMFILE
Failure to create a new user file descriptor or file
structure.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Evolving |
+--------------------+-----------------+
|MT-Level | Safe |
+--------------------+-----------------+
SEE ALSO
in.h(3HEAD), libsctp(3LIB), socket(3SOCKET), sctp(4P)
March 5, 2004 SCTP_PEELOFF(3SOCKET)