Go to main content

man pages section 3: Basic Library Functions

Exit Print View

Updated: Thursday, June 13, 2019
 
 

sctp_peeloff(3C)

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... –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.

EOPNOTSUPP

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
Committed
MT-Level
Safe

See Also

socket(3C), in.h(3HEAD), libsctp(3LIB), sctp(4P)