preprocessor cleanup: __lint
[unleashed/tickless.git] / lib / libc / socketpair.2
blob0f157352782e86ced1315aba69c0a1204c259e9c
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 $
3 .\"
4 .\" Copyright (c) 1983, 1991, 1993
5 .\"     The Regents of the University of California.  All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
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.
18 .\"
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
29 .\" SUCH DAMAGE.
30 .\"
31 .\"     @(#)socketpair.2        8.1 (Berkeley) 6/4/93
32 .\"
33 .Dd October 26, 2016
34 .Dt SOCKETPAIR 2
35 .Os
36 .Sh NAME
37 .Nm socketpair
38 .Nd create a pair of connected sockets
39 .Sh SYNOPSIS
40 .In sys/socket.h
41 .Ft int
42 .Fn socketpair "int d" "int type" "int protocol" "int sv[2]"
43 .Sh DESCRIPTION
44 The
45 .Fn socketpair
46 call creates an unnamed pair of connected sockets in
47 the specified domain
48 .Fa d ,
49 of the specified
50 .Fa type ,
51 and using the optionally specified
52 .Fa protocol .
53 The descriptors used in referencing the new sockets
54 are returned in
55 .Fa sv Ns [0]
56 and
57 .Fa sv Ns [1] .
58 The two sockets are indistinguishable.
59 .Pp
60 Any combination of the following flags may additionally be used in the
61 .Fa type
62 argument:
63 .Pp
64 .Bl -tag -width "SOCK_NONBLOCKX" -offset indent -compact
65 .It SOCK_CLOEXEC
66 Set close-on-exec flag on both the new descriptors.
67 .It SOCK_NONBLOCK
68 Set non-blocking I/O mode on both the new sockets.
69 .El
70 .Sh RETURN VALUES
71 .Rv -std
72 .Sh ERRORS
73 The call succeeds unless:
74 .Bl -tag -width Er
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.
79 .It Bq Er EOPNOTSUPP
80 The specified protocol does not support creation of socket pairs.
81 .It Bq Er EPROTOTYPE
82 The combination of the specified protocol and type is not supported.
83 .It Bq Er EMFILE
84 The per-process descriptor table is full.
85 .It Bq Er ENFILE
86 The system file table is full.
87 .It Bq Er ENOBUFS
88 Insufficient resources were available in the system
89 to perform the operation.
90 .It Bq Er ENOMEM
91 Insufficient user memory was available to perform the operation.
92 .It Bq Er EFAULT
93 The address
94 .Fa sv
95 does not specify a valid part of the
96 process address space.
97 .El
98 .Sh SEE ALSO
99 .Xr pipe 2 ,
100 .Xr read 2 ,
101 .Xr socket 2 ,
102 .Xr write 2
103 .Sh STANDARDS
105 .Fn socketpair
106 function conforms to
107 .St -p1003.1-2008 .
109 .Dv SOCK_CLOEXEC
111 .Dv SOCK_NONBLOCK
112 flags are expected to conform to a future revision of that standard.
113 .Sh HISTORY
115 .Fn socketpair
116 function call appeared in
117 .Bx 4.2 .
118 .Sh BUGS
119 This call is currently implemented only for the
120 .Dv AF_UNIX
121 domain.