usr/src/man/man3socket/sctp_peeloff.3socket

   1 '\" te
   2 .\" Copyright (c) 2004, Sun Microsystems, Inc.
   3 .\" All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH SCTP_PEELOFF 3SOCKET "Mar 05, 2004"
   8 .SH NAME
   9 sctp_peeloff \- branch off existing association from a one-to-many SCTP socket
  10 to create a one-to-one STP socket
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lsocket\fR \fB -lnsl \fR \fB -lsctp \fR [ \fIlibrary\fR... ]
  15 #include <sys/types.h>
  16 #include <sys/socket.h>
  17 #include <netinet/sctp.h>
  18
  19 \fBint\fR \fBsctp_peeloff\fR(\fBint\fR \fIsock\fR, \fBsctp_assoc_t\fR \fIid\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .LP
  24 The \fBsctp_peeloff()\fR function branches off an existing association from a
  25 one-to-many style SCTP socket into a separate socket file descriptor. The
  26 resulting branched-off socket is a one-to-one style SCTP socket and is confined
  27 to operations allowed on a one-to-one style SCTP socket.
  28 .sp
  29 .LP
  30 The \fIsock\fR argument is a one-to-many socket. The association specified by
  31 the \fIid\fR argument is branched off \fIsock\fR.
  32 .SH RETURN VALUES
  33 .LP
  34 Upon successful completion, the \fBsctp_peeloff()\fR function returns the file
  35 descriptor that references the branched-off socket. The function returns
  36 \fB-1\fR if an error occurs.
  37 .SH ERRORS
  38 .LP
  39 The \fBsctp_peeloff()\fR function fails under the following conditions.
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fBEOPTNOTSUPP\fR\fR
  44 .ad
  45 .RS 15n
  46 The \fIsock\fR argument is not a one-to-many style SCTP socket.
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fBEINVAL\fR\fR
  53 .ad
  54 .RS 15n
  55 The \fIid\fR is \fB0\fR or greater than the maximum number of associations for
  56 \fIsock\fR.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBEMFILE\fR\fR
  63 .ad
  64 .RS 15n
  65 Failure to create a new user file descriptor or file structure.
  66 .RE
  67
  68 .SH ATTRIBUTES
  69 .LP
  70 See \fBattributes\fR(5) for descriptions of the following attributes:
  71 .sp
  72
  73 .sp
  74 .TS
  75 box;
  76 c | c
  77 l | l .
  78 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  79 _
  80 Interface Stability     Evolving
  81 _
  82 MT-Level        Safe
  83 .TE
  84
  85 .SH SEE ALSO
  86 .LP
  87 \fBin.h\fR(3HEAD), \fBlibsctp\fR(3LIB), \fBsocket\fR(3SOCKET), \fBsctp\fR(7P)