socketpair — create a pair of connected sockets
#include <sys/types.h> /* See NOTES */ #include <sys/socket.h>
int
socketpair( |
int domain, |
int type, | |
int protocol, | |
int sv[2]) ; |
The socketpair
() call
creates an unnamed pair of connected sockets in the specified
domain
, of the
specified type
, and
using the optionally specified protocol
. For further details
of these arguments, see socket(2).
The file descriptors used in referencing the new sockets
are returned in sv
[0]
and sv
[1]. The two
sockets are indistinguishable.
On success, zero is returned. On error, −1 is
returned, and errno
is set
appropriately.
On Linux (and other systems), socketpair
() does not modify sv
on failure. A requirement
standardizing this behavior was added in POSIX.1-2016.
The specified address family is not supported on this machine.
The address sv
does not specify a
valid part of the process address space.
The per-process limit on the number of open file descriptors has been reached.
The system-wide limit on the total number of open files has been reached.
The specified protocol does not support creation of socket pairs.
The specified protocol is not supported on this machine.
POSIX.1-2001, POSIX.1-2008, 4.4BSD. socketpair
() first appeared in 4.2BSD. It
is generally portable to/from non-BSD systems supporting
clones of the BSD socket layer (including System V
variants).
On Linux, the only supported domain for this call is
AF_UNIX
(or synonymously,
AF_LOCAL
). (Most
implementations have the same restriction.)
Since Linux 2.6.27, socketpair
() supports the SOCK_NONBLOCK
and SOCK_CLOEXEC
flags in the type
argument, as described in
socket(2).
POSIX.1 does not require the inclusion of <
sys/types.h
>
and this header file is not required on
Linux. However, some historical (BSD) implementations
required this header file, and portable applications are
probably wise to include it.
This page is part of release 4.07 of the Linux man-pages
project. A
description of the project, information about reporting bugs,
and the latest version of this page, can be found at
https://www.kernel.org/doc/man−pages/.
Copyright (c) 1983, 1991 The Regents of the University of California. All rights reserved. %%%LICENSE_START(BSD_4_CLAUSE_UCB) 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. %%%LICENSE_END (#)socketpair.2 6.4 (Berkeley) 3/10/91 Modified 1993-07-24 by Rik Faith <faithcs.unc.edu> Modified 1996-10-22 by Eric S. Raymond <esrthyrsus.com> Modified 2002-07-22 by Michael Kerrisk <mtk.manpagesgmail.com> Modified 2004-06-17 by Michael Kerrisk <mtk.manpagesgmail.com> 2008-10-11, mtk: Add description of SOCK_NONBLOCK and SOCK_CLOEXEC |