[apple/xnu.git] / bsd / man / man2 / socketpair.2

.\"	$NetBSD: socketpair.2,v 1.5 1995/02/27 12:38:00 cgd Exp $
.\"
.\" Copyright (c) 1983, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)socketpair.2	8.1 (Berkeley) 6/4/93
.\"
.Dd June 4, 1993
.Dt SOCKETPAIR 2
.Os BSD 4.2
.Sh NAME
.Nm socketpair
.Nd create a pair of connected sockets
.Sh SYNOPSIS
.Fd #include <sys/socket.h>
.Ft int
.Fo socketpair
.Fa "int domain"
.Fa "int type"
.Fa "int protocol"
.Fa "int socket_vector[2]"
.Fc
.Sh DESCRIPTION
The
.Fn socketpair
call creates an unnamed pair of connected sockets in
the specified domain
.Fa domain ,
of the specified
.Fa type ,
and using the optionally specified
.Fa protocol .
The descriptors used in referencing the new sockets
are returned in
.Fa socket_vector Ns [0]
and
.Fa socket_vector Ns [1] .
The two sockets are indistinguishable.
.Sh RETURN VALUES
.Rv -std socketpair
.Sh ERRORS
The call succeeds unless:
.Bl -tag -width Er
.\" ===========
.It Bq Er EAFNOSUPPORT
The specified address family is not supported on this machine.
.\" ===========
.It Bq Er EFAULT
The address
.Fa socket_vector
does not specify a valid part of the process address space.
.\" ===========
.It Bq Er EMFILE
No more file descriptors are available for this process.
.\" ===========
.It Bq Er ENFILE
No more file descriptors are available for the system.
.\" ===========
.It Bq Er ENOBUFS
Insufficient resources were available in the system
to perform the operation.
.\" ===========
.It Bq Er ENOMEM
Insufficient memory was available to fulfill the request.
.\" ===========
.It Bq Er EOPNOTSUPP
The specified protocol does not support creation of socket pairs.
.\" ===========
.It Bq Er EPROTONOSUPPORT
The specified protocol is not supported on this machine.
.\" ===========
.It Bq Er EPROTOTYPE
The socket type is not supported by the protocol.
.\" ===========
.It Bq Er EACCES
The process does not have appropriate privileges to create a socket of the 
specified type and/or protocol.
.El
.Sh LEGACY SYNOPSIS
.Fd #include <sys/types.h>
.Fd #include <sys/socket.h>
.Pp
The include file
.In sys/types.h
is necessary.
.Sh SEE ALSO
.Xr socket 2 ,
.Xr read 2 ,
.Xr write 2 ,
.Xr compat 5
.Sh BUGS
This call is currently implemented only for the
.Tn UNIX
domain.
.Sh HISTORY
The
.Fn socketpair
function call appeared in
.Bx 4.2 .
Commit	Line	Data
9bccf70c A	1	.\" $NetBSD: socketpair.2,v 1.5 1995/02/27 12:38:00 cgd Exp $
	2	.\"
	3	.\" Copyright (c) 1983, 1991, 1993
	4	.\" The Regents of the University of California. All rights reserved.
	5	.\"
	6	.\" Redistribution and use in source and binary forms, with or without
	7	.\" modification, are permitted provided that the following conditions
	8	.\" are met:
	9	.\" 1. Redistributions of source code must retain the above copyright
	10	.\" notice, this list of conditions and the following disclaimer.
	11	.\" 2. Redistributions in binary form must reproduce the above copyright
	12	.\" notice, this list of conditions and the following disclaimer in the
	13	.\" documentation and/or other materials provided with the distribution.
	14	.\" 3. All advertising materials mentioning features or use of this software
	15	.\" must display the following acknowledgement:
	16	.\" This product includes software developed by the University of
	17	.\" California, Berkeley and its contributors.
	18	.\" 4. Neither the name of the University nor the names of its contributors
	19	.\" may be used to endorse or promote products derived from this software
	20	.\" without specific prior written permission.
	21	.\"
	22	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	23	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	24	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	25	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	26	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	27	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	28	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	29	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	30	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	31	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	32	.\" SUCH DAMAGE.
	33	.\"
	34	.\" @(#)socketpair.2 8.1 (Berkeley) 6/4/93
	35	.\"
	36	.Dd June 4, 1993
	37	.Dt SOCKETPAIR 2
	38	.Os BSD 4.2
	39	.Sh NAME
	40	.Nm socketpair
	41	.Nd create a pair of connected sockets
	42	.Sh SYNOPSIS
9bccf70c A	43	.Fd #include <sys/socket.h>
9bccf70c A	44	.Ft int
2d21ac55 A	45	.Fo socketpair
	46	.Fa "int domain"
	47	.Fa "int type"
	48	.Fa "int protocol"
	49	.Fa "int socket_vector[2]"
	50	.Fc
9bccf70c A	51	.Sh DESCRIPTION
	52	The
	53	.Fn socketpair
	54	call creates an unnamed pair of connected sockets in
	55	the specified domain
2d21ac55	56	.Fa domain ,
9bccf70c A	57	of the specified
	58	.Fa type ,
	59	and using the optionally specified
	60	.Fa protocol .
	61	The descriptors used in referencing the new sockets
	62	are returned in
2d21ac55	63	.Fa socket_vector Ns [0]
9bccf70c	64	and
2d21ac55	65	.Fa socket_vector Ns [1] .
9bccf70c	66	The two sockets are indistinguishable.
2d21ac55 A	67	.Sh RETURN VALUES
2d21ac55 A	68	.Rv -std socketpair
9bccf70c A	69	.Sh ERRORS
	70	The call succeeds unless:
	71	.Bl -tag -width Er
2d21ac55	72	.\" ===========
9bccf70c A	73	.It Bq Er EAFNOSUPPORT
9bccf70c A	74	The specified address family is not supported on this machine.
2d21ac55	75	.\" ===========
9bccf70c A	76	.It Bq Er EFAULT
9bccf70c A	77	The address
2d21ac55 A	78	.Fa socket_vector
	79	does not specify a valid part of the process address space.
	80	.\" ===========
	81	.It Bq Er EMFILE
	82	No more file descriptors are available for this process.
	83	.\" ===========
	84	.It Bq Er ENFILE
	85	No more file descriptors are available for the system.
	86	.\" ===========
	87	.It Bq Er ENOBUFS
	88	Insufficient resources were available in the system
	89	to perform the operation.
	90	.\" ===========
	91	.It Bq Er ENOMEM
	92	Insufficient memory was available to fulfill the request.
	93	.\" ===========
	94	.It Bq Er EOPNOTSUPP
	95	The specified protocol does not support creation of socket pairs.
	96	.\" ===========
	97	.It Bq Er EPROTONOSUPPORT
	98	The specified protocol is not supported on this machine.
	99	.\" ===========
	100	.It Bq Er EPROTOTYPE
	101	The socket type is not supported by the protocol.
b0d623f7 A	102	.\" ===========
	103	.It Bq Er EACCES
	104	The process does not have appropriate privileges to create a socket of the
	105	specified type and/or protocol.
9bccf70c	106	.El
2d21ac55 A	107	.Sh LEGACY SYNOPSIS
	108	.Fd #include <sys/types.h>
	109	.Fd #include <sys/socket.h>
	110	.Pp
	111	The include file
	112	.In sys/types.h
	113	is necessary.
9bccf70c	114	.Sh SEE ALSO
b0d623f7	115	.Xr socket 2 ,
9bccf70c A	116	.Xr read 2 ,
9bccf70c A	117	.Xr write 2 ,
2d21ac55	118	.Xr compat 5
9bccf70c A	119	.Sh BUGS
	120	This call is currently implemented only for the
	121	.Tn UNIX
	122	domain.
	123	.Sh HISTORY
	124	The
	125	.Fn socketpair
	126	function call appeared in
	127	.Bx 4.2 .