xref: /freebsd/lib/libsys/sctp_peeloff.2 (revision 5f757f3f)
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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd February 2, 2024
29.Dt SCTP_PEELOFF 2
30.Os
31.Sh NAME
32.Nm sctp_peeloff
33.Nd detach an association from a one-to-many socket to its own fd
34.Sh LIBRARY
35.Lb libc
36.Sh SYNOPSIS
37.In sys/types.h
38.In sys/socket.h
39.In netinet/sctp.h
40.Ft int
41.Fn sctp_peeloff "int s" "sctp_assoc_t id"
42.Sh DESCRIPTION
43The
44.Fn sctp_peeloff
45system call attempts detach the association specified by
46.Fa id
47into its own separate socket.
48.Sh RETURN VALUES
49The call returns -1 on failure and the new socket descriptor
50upon success.
51.Sh ERRORS
52The
53.Fn sctp_peeloff
54system call can return the following errors:
55.Bl -tag -width Er
56.It Bq Er ENOTCONN
57The
58.Fa id
59given to the call does not map to a valid
60association.
61.It Bq Er E2BIG
62The size of the address list exceeds the amount of
63data provided.
64.It Bq Er EBADF
65The argument
66.Fa s
67is not a valid descriptor.
68.It Bq Er ENOTSOCK
69The argument
70.Fa s
71is not a socket.
72.El
73.Sh SEE ALSO
74.Xr sctp 4
75.Sh STANDARDS
76The
77.Fn sctp_peeloff
78function conforms to RFC 6458.
79