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