sctp_peeloff(3) [centos man page]

SCTP_PEELOFF(3) 					     Linux Programmer's Manual						   SCTP_PEELOFF(3)

NAME

       sctp_peeloff - Branch off an association into a separate socket.

SYNOPSIS

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

       int sctp_peeloff(int sd, sctp_assoc_t assoc_id);

DESCRIPTION

       sctp_peeloff  branches  off  an	existing association assoc_id on a one-to-many style socket sd into a separate socket. The new socket is a
       one-to-one style socket.

       This is particularly desirable when, for instance, the application wishes to have a number of  sporadic	message  senders/receivers  remain
       under  the  original  one-to-many  style socket, but branch off those assocations carrying high volume data traffic into their own separate
       socket descriptors.

RETURN VALUE

       On success, the new socket descriptor representing the branched-off asociation is returned.  On error, -1 is returned,  and  errno  is  set
       appropriately.

ERRORS

       EBADF  sd is not a valid descriptor.

       EINVAL The assoc id passed is invalid or if the socket is a one-to-one style socket.

       ENOTSOCK
	      Argument is a descriptor for a file, not a socket.

SEE ALSO

       sctp(7)	 sctp_bindx(3),   sctp_connectx(3),   sctp_sendmsg(3),	 sctp_send(3),	 sctp_recvmsg(3),   sctp_getpaddrs(3),	sctp_getladdrs(3),
       sctp_opt_info(3),

Linux 2.6							    2005-10-25							   SCTP_PEELOFF(3)

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.10							    05 Mar 2004 					     sctp_peeloff(3SOCKET)