lib/libc/sys/socketpair.2

   1 .\"     $NetBSD: socketpair.2,v 1.23 2011/06/27 08:21:08 wiz 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. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)socketpair.2        8.1 (Berkeley) 6/4/93
  31 .\"
  32 .Dd June 24, 2011
  33 .Dt SOCKETPAIR 2
  34 .Os
  35 .Sh NAME
  36 .Nm socketpair
  37 .Nd create a pair of connected sockets
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In sys/socket.h
  42 .Ft int
  43 .Fn socketpair "int d" "int type" "int protocol" "int *sv"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn socketpair
  47 call creates an unnamed pair of connected sockets in
  48 the specified domain
  49 .Fa d ,
  50 of the specified
  51 .Fa type ,
  52 and using the optionally specified
  53 .Fa protocol .
  54 The descriptors used in referencing the new sockets
  55 are returned in
  56 .Fa sv[0]
  57 and
  58 .Fa sv[1] .
  59 The two sockets are indistinguishable.
  60 .Pp
  61 The
  62 .Fa type
  63 and
  64 .Fa protocol
  65 argument values are described in
  66 .Xr socket 2 .
  67 .Sh RETURN VALUES
  68 A 0 is returned if the call succeeds, \-1 if it fails.
  69 .Sh ERRORS
  70 The call succeeds unless:
  71 .Bl -tag -width Er
  72 .It Bq Er EAFNOSUPPORT
  73 The specified address family is not supported on this machine.
  74 .It Bq Er EFAULT
  75 The address
  76 .Fa sv
  77 does not specify a valid part of the
  78 process address space.
  79 .It Bq Er EMFILE
  80 Too many descriptors are in use by this process.
  81 .It Bq Er ENFILE
  82 The system file table is full.
  83 .It Bq Er EOPNOTSUPP
  84 The specified protocol does not support creation of socket pairs.
  85 .It Bq Er EPROTONOSUPPORT
  86 The specified protocol is not supported on this machine.
  87 .El
  88 .Sh SEE ALSO
  89 .Xr pipe 2 ,
  90 .Xr read 2 ,
  91 .Xr socket 2 ,
  92 .Xr write 2
  93 .Sh HISTORY
  94 The
  95 .Fn socketpair
  96 function call appeared in
  97 .Bx 4.2 .
  98 .Sh BUGS
  99 This call is currently implemented only for the
 100 .Dv PF_LOCAL
 101 domain.