lib/libc/sys/sctp_peeloff.2

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\" $FreeBSD$
  33 .\"
  34 .Dd October 30, 2007
  35 .Dt SCTP_PEELOFF 2
  36 .Os
  37 .Sh NAME
  38 .Nm sctp_peeloff
  39 .Nd detach an association from a one-to-many socket to its own fd
  40 .Sh LIBRARY
  41 .Lb libc
  42 .Sh SYNOPSIS
  43 .In sys/types.h
  44 .In sys/socket.h
  45 .In netinet/sctp.h
  46 .Ft int
  47 .Fn sctp_peeloff "int s" "sctp_assoc_t id"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn sctp_peeloff
  51 system call attempts detach the association specified by
  52 .Fa id
  53 into its own separate socket.
  54 .Pp
  55 .Sh RETURN VALUES
  56 The call returns -1 on failure and the new socket descriptor
  57 upon success.
  58 .Sh ERRORS
  59 The
  60 .Fn sctp_peeloff
  61 system call can return the following errors:
  62 .Bl -tag -width Er
  63 .It Bq Er ENOTCONN
  64 The
  65 .Fa id
  66 given to the call does not map to a valid
  67 association.
  68 .It Bq Er E2BIG
  69 The size of the address list exceeds the amount of
  70 data provided.
  71 .It Bq Er EBADF
  72 The argument
  73 .Fa s
  74 is not a valid descriptor.
  75 .It Bq Er ENOTSOCK
  76 The argument
  77 .Fa s
  78 is not a socket.
  79 .El
  80 .Sh SEE ALSO
  81 .Xr sctp 4