mount_setattr.2: SEE ALSO: place entries in correct order
[man-pages.git] / man2 / socketpair.2
bloba799babdae487c79eb0ac90d36c1ba930d6b0cf7
1 .\" Copyright (c) 1983, 1991 The Regents of the University of California.
2 .\" All rights reserved.
3 .\"
4 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\" 3. All advertising materials mentioning features or use of this software
14 .\"    must display the following acknowledgement:
15 .\"     This product includes software developed by the University of
16 .\"     California, Berkeley and its contributors.
17 .\" 4. Neither the name of the University nor the names of its contributors
18 .\"    may be used to endorse or promote products derived from this software
19 .\"    without specific prior written permission.
20 .\"
21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .\" SUCH DAMAGE.
32 .\" %%%LICENSE_END
33 .\"
34 .\"     @(#)socketpair.2        6.4 (Berkeley) 3/10/91
35 .\"
36 .\" Modified 1993-07-24 by Rik Faith <faith@cs.unc.edu>
37 .\" Modified 1996-10-22 by Eric S. Raymond <esr@thyrsus.com>
38 .\" Modified 2002-07-22 by Michael Kerrisk <mtk.manpages@gmail.com>
39 .\" Modified 2004-06-17 by Michael Kerrisk <mtk.manpages@gmail.com>
40 .\" 2008-10-11, mtk: Add description of SOCK_NONBLOCK and SOCK_CLOEXEC
41 .\"
42 .TH SOCKETPAIR 2 2021-03-22 "Linux" "Linux Programmer's Manual"
43 .SH NAME
44 socketpair \- create a pair of connected sockets
45 .SH SYNOPSIS
46 .nf
47 .B #include <sys/socket.h>
48 .PP
49 .BI "int socketpair(int " domain ", int " type ", int " protocol \
50 ", int " sv [2]);
51 .fi
52 .SH DESCRIPTION
53 The
54 .BR socketpair ()
55 call creates an unnamed pair of connected sockets in the specified
56 .IR domain ,
57 of the specified
58 .IR type ,
59 and using the optionally specified
60 .IR protocol .
61 For further details of these arguments, see
62 .BR socket (2).
63 .PP
64 The file descriptors used in referencing the new sockets are returned in
65 .I sv[0]
66 and
67 .IR sv[1] .
68 The two sockets are indistinguishable.
69 .SH RETURN VALUE
70 On success, zero is returned.
71 On error, \-1 is returned,
72 .I errno
73 is set to indicate the error, and
74 .I sv
75 is left unchanged
76 .PP
77 On Linux (and other systems),
78 .BR socketpair ()
79 does not modify
80 .I sv
81 on failure.
82 A requirement standardizing this behavior was added in POSIX.1-2008 TC2.
83 .\" http://austingroupbugs.net/view.php?id=483
84 .SH ERRORS
85 .TP
86 .B EAFNOSUPPORT
87 The specified address family is not supported on this machine.
88 .TP
89 .B EFAULT
90 The address
91 .I sv
92 does not specify a valid part of the process address space.
93 .TP
94 .B EMFILE
95 The per-process limit on the number of open file descriptors has been reached.
96 .TP
97 .B ENFILE
98 The system-wide limit on the total number of open files has been reached.
99 .TP
100 .B EOPNOTSUPP
101 The specified protocol does not support creation of socket pairs.
103 .B EPROTONOSUPPORT
104 The specified protocol is not supported on this machine.
105 .SH CONFORMING TO
106 POSIX.1-2001, POSIX.1-2008, 4.4BSD.
107 .BR socketpair ()
108 first appeared in 4.2BSD.
109 It is generally portable to/from
110 non-BSD systems supporting clones of the BSD socket layer (including
111 System\ V variants).
112 .SH NOTES
113 On Linux, the only supported domains for this call are
114 .B AF_UNIX
115 (or synonymously,
116 .BR AF_LOCAL )
118 .B AF_TIPC
119 .\" commit: 70b03759e9ecfae400605fa34f3d7154cccbbba3
120 (since Linux 4.12).
122 Since Linux 2.6.27,
123 .BR socketpair ()
124 supports the
125 .BR SOCK_NONBLOCK
127 .BR SOCK_CLOEXEC
128 flags in the
129 .I type
130 argument, as described in
131 .BR socket (2).
132 .SH SEE ALSO
133 .BR pipe (2),
134 .BR read (2),
135 .BR socket (2),
136 .BR write (2),
137 .BR socket (7),
138 .BR unix (7)