xref: /illumos-gate/usr/src/man/man3socket/socketpair.3socket (revision 068cf9dc70b00292d5e5ff1ab17f1b046215d6f6)
te
Copyright 1989 AT&T
Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
SOCKETPAIR 3SOCKET "June 21, 2024"
NAME
socketpair - create a pair of connected sockets
SYNOPSIS
cc [ flag ... ] file ... -lsocket  -lnsl  [ library ... ]
#include <sys/types.h>
#include <sys/socket.h>

int socketpair(int domain, int type, int protocol, int sv[2]);
DESCRIPTION
The socketpair() library call creates an unnamed pair of connected sockets in the specified address family domain, of the specified type, that uses the optionally specified protocol. The descriptors that are used in referencing the new sockets are returned in sv[0] and sv[1]. The two sockets are indistinguishable.

The type arguments supports the various flags that modify the returned socket's behavior that are discussed in socket(3SOCKET): SOCK_CLOEXEC, SOCK_CLOFORK, SOCK_NDELAY, and SOCK_NONBLOCK.

RETURN VALUES
socketpair() returns -1 on failure and 0 on success.
ERRORS
The call succeeds unless: EAFNOSUPPORT

The specified address family is not supported on this machine.

EMFILE

Too many descriptors are in use by this process.

ENOMEM

There was insufficient user memory for the operation to complete.

ENOSR

There were insufficient STREAMS resources for the operation to complete.

EOPNOTSUPP

The specified protocol does not support creation of socket pairs.

EPROTONOSUPPORT

The specified protocol is not supported on this machine.

EACCES

The process does not have appropriate privileges.

ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level Safe
SEE ALSO
pipe (2), read (2), write (2), socket.h (3HEAD), attributes (7)
NOTES
This call is currently implemented only for the AF_UNIX address family.