]>
Commit | Line | Data |
---|---|---|
fea681da MK |
1 | .\" Copyright (c) 1983, 1991 The Regents of the University of California. |
2 | .\" 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 | .\" @(#)socketpair.2 6.4 (Berkeley) 3/10/91 | |
33 | .\" | |
34 | .\" Modified 1993-07-24 by Rik Faith <faith@cs.unc.edu> | |
35 | .\" Modified 1996-10-22 by Eric S. Raymond <esr@thyrsus.com> | |
305a0578 MK |
36 | .\" Modified 2002-07-22 by Michael Kerrisk <mtk-manpages@gmx.net> |
37 | .\" Modified 2004-06-17 by Michael Kerrisk <mtk-manpages@gmx.net> | |
fea681da | 38 | .\" |
d9343c5c | 39 | .TH SOCKETPAIR 2 2004-06-17 "Linux" "Linux Programmer's Manual" |
fea681da MK |
40 | .SH NAME |
41 | socketpair \- create a pair of connected sockets | |
42 | .SH SYNOPSIS | |
43 | .B #include <sys/types.h> | |
44 | .br | |
45 | .B #include <sys/socket.h> | |
46 | .sp | |
47 | .BI "int socketpair(int " d ", int " type ", int " protocol ", int " sv [2]); | |
48 | .SH DESCRIPTION | |
49 | The | |
31e9a9ec | 50 | .BR socketpair () |
fea681da MK |
51 | call creates an unnamed pair of connected sockets in |
52 | the specified domain | |
53 | .IR d , | |
54 | of the specified | |
55 | .IR type , | |
56 | and using the optionally specified | |
57 | .IR protocol . | |
58 | The descriptors used in referencing the new sockets are returned in | |
59 | .IR sv [0] | |
60 | and | |
61 | .IR sv [1]. | |
62 | The two sockets are indistinguishable. | |
63 | .SH "RETURN VALUE" | |
c13182ef MK |
64 | On success, zero is returned. |
65 | On error, \-1 is returned, and | |
fea681da MK |
66 | .I errno |
67 | is set appropriately. | |
68 | .SH ERRORS | |
69 | .TP | |
70 | .B EAFNOSUPPORT | |
71 | The specified address family is not supported on this machine. | |
72 | .TP | |
73 | .B EFAULT | |
74 | The address | |
75 | .I sv | |
76 | does not specify a valid part of the process address space. | |
77 | .TP | |
78 | .B EMFILE | |
79 | Too many descriptors are in use by this process. | |
80 | .TP | |
81 | .B ENFILE | |
82 | The system limit on the total number of open files has been reached. | |
83 | .TP | |
84 | .B EOPNOTSUPP | |
85 | The specified protocol does not support creation of socket pairs. | |
86 | .TP | |
87 | .B EPROTONOSUPPORT | |
88 | The specified protocol is not supported on this machine. | |
89 | .SH "CONFORMING TO" | |
97c1eac8 | 90 | 4.4BSD, POSIX.1-2001. |
fea681da | 91 | The |
e511ffb6 | 92 | .BR socketpair () |
1c44bd5b MK |
93 | function call appeared in 4.2BSD. |
94 | It is generally portable to/from | |
fea681da MK |
95 | non-BSD systems supporting clones of the BSD socket layer (including |
96 | System V variants). | |
97 | .SH NOTES | |
c13182ef | 98 | On Linux, the only supported domain for this call is |
fea681da MK |
99 | .BR AF_UNIX |
100 | (or synonymously, | |
101 | .BR AF_LOCAL ). | |
102 | (Most implementations have the same restriction.) | |
103 | .SH "SEE ALSO" | |
104 | .BR pipe (2), | |
105 | .BR read (2), | |
106 | .BR socket (2), | |
107 | .BR write (2), | |
108 | .BR unix (7) |