xref: /freebsd/lib/libsys/socketpair.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 10, 2018
29*8269e767SBrooks Davis.Dt SOCKETPAIR 2
30*8269e767SBrooks Davis.Os
31*8269e767SBrooks Davis.Sh NAME
32*8269e767SBrooks Davis.Nm socketpair
33*8269e767SBrooks Davis.Nd create a pair of connected sockets
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.Ft int
40*8269e767SBrooks Davis.Fn socketpair "int domain" "int type" "int protocol" "int *sv"
41*8269e767SBrooks Davis.Sh DESCRIPTION
42*8269e767SBrooks DavisThe
43*8269e767SBrooks Davis.Fn socketpair
44*8269e767SBrooks Davissystem call creates an unnamed pair of connected sockets in
45*8269e767SBrooks Davisthe specified communications
46*8269e767SBrooks Davis.Fa domain ,
47*8269e767SBrooks Davisof the specified
48*8269e767SBrooks Davis.Fa type ,
49*8269e767SBrooks Davisand using the optionally specified
50*8269e767SBrooks Davis.Fa protocol .
51*8269e767SBrooks DavisThe descriptors used in referencing the new sockets
52*8269e767SBrooks Davisare returned in
53*8269e767SBrooks Davis.Fa sv Ns [0]
54*8269e767SBrooks Davisand
55*8269e767SBrooks Davis.Fa sv Ns [1] .
56*8269e767SBrooks DavisThe two sockets are indistinguishable.
57*8269e767SBrooks Davis.Pp
58*8269e767SBrooks DavisThe
59*8269e767SBrooks Davis.Dv SOCK_CLOEXEC
60*8269e767SBrooks Davisand
61*8269e767SBrooks Davis.Dv SOCK_NONBLOCK
62*8269e767SBrooks Davisflags in the
63*8269e767SBrooks Davis.Fa type
64*8269e767SBrooks Davisargument apply to both descriptors.
65*8269e767SBrooks Davis.Sh RETURN VALUES
66*8269e767SBrooks Davis.Rv -std socketpair
67*8269e767SBrooks Davis.Sh ERRORS
68*8269e767SBrooks DavisThe call succeeds unless:
69*8269e767SBrooks Davis.Bl -tag -width Er
70*8269e767SBrooks Davis.It Bq Er EMFILE
71*8269e767SBrooks DavisToo many descriptors are in use by this process.
72*8269e767SBrooks Davis.It Bq Er EAFNOSUPPORT
73*8269e767SBrooks DavisThe specified address family is not supported on this machine.
74*8269e767SBrooks Davis.It Bq Er EPROTONOSUPPORT
75*8269e767SBrooks DavisThe specified protocol is not supported on this machine.
76*8269e767SBrooks Davis.It Bq Er EOPNOTSUPP
77*8269e767SBrooks DavisThe specified protocol does not support creation of socket pairs.
78*8269e767SBrooks Davis.It Bq Er EFAULT
79*8269e767SBrooks DavisThe address
80*8269e767SBrooks Davis.Fa sv
81*8269e767SBrooks Davisdoes not specify a valid part of the
82*8269e767SBrooks Davisprocess address space.
83*8269e767SBrooks Davis.El
84*8269e767SBrooks Davis.Sh SEE ALSO
85*8269e767SBrooks Davis.Xr pipe 2 ,
86*8269e767SBrooks Davis.Xr read 2 ,
87*8269e767SBrooks Davis.Xr socket 2 ,
88*8269e767SBrooks Davis.Xr write 2
89*8269e767SBrooks Davis.Sh STANDARDS
90*8269e767SBrooks DavisThe
91*8269e767SBrooks Davis.Fn socketpair
92*8269e767SBrooks Davissystem call conforms to
93*8269e767SBrooks Davis.St -p1003.1-2001
94*8269e767SBrooks Davisand
95*8269e767SBrooks Davis.St -p1003.1-2008 .
96*8269e767SBrooks Davis.Sh HISTORY
97*8269e767SBrooks DavisThe
98*8269e767SBrooks Davis.Fn socketpair
99*8269e767SBrooks Davissystem call appeared in
100*8269e767SBrooks Davis.Bx 4.2 .
101*8269e767SBrooks Davis.Sh BUGS
102*8269e767SBrooks DavisThis call is currently implemented only for the
103*8269e767SBrooks Davis.Ux
104*8269e767SBrooks Davisdomain.
105