original/man2/socketpair.2

   1 .\" Copyright (c) 1983, 1991 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by the University of
  16 .\"     California, Berkeley and its contributors.
  17 .\" 4. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\" %%%LICENSE_END
  33 .\"
  34 .\"     @(#)socketpair.2        6.4 (Berkeley) 3/10/91
  35 .\"
  36 .\" Modified 1993-07-24 by Rik Faith <faith@cs.unc.edu>
  37 .\" Modified 1996-10-22 by Eric S. Raymond <esr@thyrsus.com>
  38 .\" Modified 2002-07-22 by Michael Kerrisk <mtk.manpages@gmail.com>
  39 .\" Modified 2004-06-17 by Michael Kerrisk <mtk.manpages@gmail.com>
  40 .\" 2008-10-11, mtk: Add description of SOCK_NONBLOCK and SOCK_CLOEXEC
  41 .\"
  42 .TH SOCKETPAIR 2 2008-10-11 "Linux" "Linux Programmer's Manual"
  43 .SH NAME
  44 socketpair \- create a pair of connected sockets
  45 .SH SYNOPSIS
  46 .BR "#include <sys/types.h>" "          /* See NOTES */"
  47 .br
  48 .B #include <sys/socket.h>
  49 .sp
  50 .BI "int socketpair(int " domain ", int " type ", int " protocol \
  51 ", int " sv [2]);
  52 .SH DESCRIPTION
  53 The
  54 .BR socketpair ()
  55 call creates an unnamed pair of connected sockets in the specified
  56 .IR domain ,
  57 of the specified
  58 .IR type ,
  59 and using the optionally specified
  60 .IR protocol .
  61 For further details of these arguments, see
  62 .BR socket (2).
  63
  64 The descriptors used in referencing the new sockets are returned in
  65 .IR sv [0]
  66 and
  67 .IR sv [1].
  68 The two sockets are indistinguishable.
  69 .SH RETURN VALUE
  70 On success, zero is returned.
  71 On error, \-1 is returned, and
  72 .I errno
  73 is set appropriately.
  74 .SH ERRORS
  75 .TP
  76 .B EAFNOSUPPORT
  77 The specified address family is not supported on this machine.
  78 .TP
  79 .B EFAULT
  80 The address
  81 .I sv
  82 does not specify a valid part of the process address space.
  83 .TP
  84 .B EMFILE
  85 Too many descriptors are in use by this process.
  86 .TP
  87 .B ENFILE
  88 The system limit on the total number of open files has been reached.
  89 .TP
  90 .B EOPNOTSUPP
  91 The specified protocol does not support creation of socket pairs.
  92 .TP
  93 .B EPROTONOSUPPORT
  94 The specified protocol is not supported on this machine.
  95 .SH CONFORMING TO
  96 4.4BSD, POSIX.1-2001.
  97 The
  98 .BR socketpair ()
  99 function call appeared in 4.2BSD.
 100 It is generally portable to/from
 101 non-BSD systems supporting clones of the BSD socket layer (including
 102 System V variants).
 103 .SH NOTES
 104 On Linux, the only supported domain for this call is
 105 .B AF_UNIX
 106 (or synonymously,
 107 .BR AF_LOCAL ).
 108 (Most implementations have the same restriction.)
 109
 110 Since Linux 2.6.27,
 111 .BR socketpair ()
 112 supports the
 113 .BR SOCK_NONBLOCK
 114 and
 115 .BR SOCK_CLOEXEC
 116 flags described in
 117 .BR socket (2).
 118
 119 POSIX.1-2001 does not require the inclusion of
 120 .IR <sys/types.h> ,
 121 and this header file is not required on Linux.
 122 However, some historical (BSD) implementations required this header
 123 file, and portable applications are probably wise to include it.
 124 .SH SEE ALSO
 125 .BR pipe (2),
 126 .BR read (2),
 127 .BR socket (2),
 128 .BR write (2),
 129 .BR socket (7),
 130 .BR unix (7)
 131 .SH COLOPHON
 132 This page is part of release 3.64 of the Linux
 133 .I man-pages
 134 project.
 135 A description of the project,
 136 and information about reporting bugs,
 137 can be found at
 138 \%http://www.kernel.org/doc/man\-pages/.