1 .\" $OpenBSD: socketpair.2,v 1.20 2016/05/29 06:01:24 guenther Exp $
2 .\" $NetBSD: socketpair.2,v 1.5 1995/02/27 12:38:00 cgd Exp $
4 .\" Copyright (c) 1983, 1991, 1993
5 .\" The Regents of the University of California. All rights reserved.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\" notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in the
14 .\" documentation and/or other materials provided with the distribution.
15 .\" 3. Neither the name of the University nor the names of its contributors
16 .\" may be used to endorse or promote products derived from this software
17 .\" without specific prior written permission.
19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .\" @(#)socketpair.2 8.1 (Berkeley) 6/4/93
38 .Nd create a pair of connected sockets
42 .Fn socketpair "int d" "int type" "int protocol" "int sv[2]"
46 call creates an unnamed pair of connected sockets in
51 and using the optionally specified
53 The descriptors used in referencing the new sockets
58 The two sockets are indistinguishable.
60 Any combination of the following flags may additionally be used in the
64 .Bl -tag -width "SOCK_NONBLOCKX" -offset indent -compact
66 Set close-on-exec flag on both the new descriptors.
68 Set non-blocking I/O mode on both the new sockets.
73 The call succeeds unless:
75 .It Bq Er EAFNOSUPPORT
76 The specified address family is not supported on this machine.
77 .It Bq Er EPROTONOSUPPORT
78 The specified protocol is not supported on this machine.
80 The specified protocol does not support creation of socket pairs.
82 The combination of the specified protocol and type is not supported.
84 The per-process descriptor table is full.
86 The system file table is full.
88 Insufficient resources were available in the system
89 to perform the operation.
91 Insufficient user memory was available to perform the operation.
95 does not specify a valid part of the
96 process address space.
112 flags are expected to conform to a future revision of that standard.
116 function call appeared in
119 This call is currently implemented only for the