sctp_peeloff(2) [freebsd man page]

SCTP_PEELOFF(2) 					      BSD System Calls Manual						   SCTP_PEELOFF(2)

NAME

     sctp_peeloff -- detach an association from a one-to-many socket to its own fd

LIBRARY

     Standard C Library (libc, -lc)

SYNOPSIS

     #include <sys/types.h>
     #include <sys/socket.h>
     #include <netinet/sctp.h>

     int
     sctp_peeloff(int s, sctp_assoc_t id);

DESCRIPTION

     The sctp_peeloff() system call attempts detach the association specified by id into its own separate socket.

RETURN VALUES

     The call returns -1 on failure and the new socket descriptor upon success.

ERRORS

     The sctp_peeloff() system call can return the following errors:

     [ENOTCONN] 	The id given to the call does not map to a valid association.

     [E2BIG]		The size of the address list exceeds the amount of data provided.

     [EBADF]		The argument s is not a valid descriptor.

     [ENOTSOCK] 	The argument s is not a socket.

SEE ALSO

     sctp(4)

BSD
								 October 30, 2007							       BSD

sctp_peeloff(3SOCKET)					     Sockets Library Functions					     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 descrip-
       tor. 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(5) 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(7P)

SunOS 5.11							    05 Mar 2004 					     sctp_peeloff(3SOCKET)