t40c term[] count fix
[minix.git] / man / man2 / socketpair.2
blob8672bf26b48da3ca33f59b41b669d67c5e73a06d
1 .TH SOCKETPAIR 2
2 .SH NAME
3 socketpair \- creates a pair of connected sockets.
4 .SH SYNOPSIS
5 .ft B
6 #include <sys/socket.h>
8 .in +5
9 .ti -5
10 int socketpair(int \fIdomain\fP, int \fItype\fP, int \fIprotocol\fP, int \fIsv[2]\fP);
11 .br
12 .ft P
13 .SH DESCRIPTION
14 socketpair() creates two connected sockets of the specified \fItype\fP 
15 in the specified \fIdomain\fP using the specified \fIprotocol\fP and 
16 stores the two resulting socket descriptors in \fIsv[2]\fP.
17 .SH RETURN VALUES
18 On success, this function returns 0, and \fIsv[2]\fP is set to the two 
19 newly created socket descriptors. On error, -1 is returned and 
20 \fIerrno\fP is set.
21 .SH ERRORS
22 .TP 15
23 [EAFNOSUPPORT]
24 The \fIdomain\fP is not supported.
25 .TP 15
26 [EPROTOTYPE]
27 The \fIprotocol\fP is not supported by the \fIdomain\fP.
28 .TP 15
29 [EPROTONOSUPPORT]
30 The \fIprotocol\fP is not supported by the \fItype\fP.
31 .TP 15
32 [EINVAL]
33 The pair of sockets aren't in a valid state or are not connection oriented sockets.
34 .TP 15
35 [EPERM]
36 The user ID, group ID, and process ID of the first socket doesn't match that of the second.
37 .SH NOTES
38 This function is only implemented for unix domain sockets. Therefore, 
39 the only valid value for \fIdomain\fP is
40 .B AF_UNIX
41 .SH SEE ALSO
42 .BR socket(2),
43 .BR unix(8)
44 .SH HISTORY
45 This function first appeared in Minix 3.1.8.