usr/src/man/man3xnet/socketpair.3xnet

   1 '\" te
   2 .\"  Copyright (c) 1992, X/Open Company Limited  All Rights Reserved  Portions Copyright (c) 1998, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" 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.
   8 .\" 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.
   9 .\" 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]
  10 .TH SOCKETPAIR 3XNET "Jun 10, 2002"
  11 .SH NAME
  12 socketpair \- create a pair of connected sockets
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lxnet\fR [ \fIlibrary\fR ... ]
  17 #include <sys/socket.h>
  18
  19 \fBint\fR \fBsocketpair\fR(\fBint\fR \fIdomain\fR, \fBint\fR \fItype\fR, \fBint\fR \fIprotocol\fR, \fBint\fR \fIsocket_vector\fR\fB[2]\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBsocketpair()\fR function creates an unbound pair of connected sockets in
  26 a specified \fIdomain\fR, of a specified \fBtype\fR, under the protocol
  27 optionally specified by the \fIprotocol\fR argument.  The two sockets are
  28 identical. The file descriptors used in referencing the created sockets are
  29 returned in \fIsocket_vector\fR\fB0\fR and \fIsocket_vector\fR\fB1\fR.
  30 .sp
  31 .LP
  32 The \fItype\fR argument specifies the socket type, which determines the
  33 semantics of communications over the socket.  The socket types supported by the
  34 system are implementation-dependent.  Possible socket types include:
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fBSOCK_STREAM\fR\fR
  39 .ad
  40 .RS 18n
  41 Provides sequenced, reliable, bidirectional, connection-mode byte streams, and
  42 may provide a transmission mechanism for out-of-band data.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fBSOCK_DGRAM\fR\fR
  49 .ad
  50 .RS 18n
  51 Provides datagrams, which are connectionless-mode, unreliable messages of fixed
  52 maximum length.
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fBSOCK_SEQPACKET\fR\fR
  59 .ad
  60 .RS 18n
  61 Provides sequenced, reliable, bidirectional, connection-mode transmission path
  62 for records.  A record can be sent using one or more output operations and
  63 received using one or more input operations, but a single operation never
  64 transfers part of more than one record.  Record boundaries are visible to the
  65 receiver via the MSG_EOR flag.
  66 .RE
  67
  68 .sp
  69 .LP
  70 If the \fIprotocol\fR argument is non-zero, it must specify a protocol that is
  71 supported by the address family.  The protocols supported by the system are
  72 implementation-dependent.
  73 .sp
  74 .LP
  75 The process may need to have appropriate privileges to use the
  76 \fBsocketpair()\fR function or to create some sockets.
  77 .SH PARAMETERS
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fIdomain\fR\fR
  82 .ad
  83 .RS 17n
  84 Specifies the communications domain in which the sockets are to be created.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fItype\fR\fR
  91 .ad
  92 .RS 17n
  93 Specifies the type of sockets to be created.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fIprotocol\fR\fR
 100 .ad
 101 .RS 17n
 102 Specifies a particular protocol to be used with the sockets. Specifying a
 103 \fIprotocol\fR of 0 causes \fBsocketpair()\fR to use an unspecified default
 104 protocol appropriate for the requested socket type.
 105 .RE
 106
 107 .sp
 108 .ne 2
 109 .na
 110 \fB\fIsocket_vector\fR\fR
 111 .ad
 112 .RS 17n
 113 Specifies a 2-integer array to hold the file descriptors of the created socket
 114 pair.
 115 .RE
 116
 117 .SH USAGE
 118 .sp
 119 .LP
 120 The documentation for specific address families specifies which protocols each
 121 address family supports.  The documentation for specific protocols specifies
 122 which socket types each protocol supports.
 123 .sp
 124 .LP
 125 The \fBsocketpair()\fR function is used primarily with UNIX domain sockets and
 126 need not be supported for other domains.
 127 .SH RETURN VALUES
 128 .sp
 129 .LP
 130 Upon successful completion, this function returns 0.  Otherwise, \(mi1 is
 131 returned and \fBerrno\fR is set to indicate the error.
 132 .SH ERRORS
 133 .sp
 134 .LP
 135 The \fBsocketpair()\fR function will fail if:
 136 .sp
 137 .ne 2
 138 .na
 139 \fB\fBEAFNOSUPPORT\fR\fR
 140 .ad
 141 .RS 19n
 142 The implementation does not support the specified address family.
 143 .RE
 144
 145 .sp
 146 .ne 2
 147 .na
 148 \fB\fBEMFILE\fR\fR
 149 .ad
 150 .RS 19n
 151 No more file descriptors are available for this process.
 152 .RE
 153
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fBENFILE\fR\fR
 158 .ad
 159 .RS 19n
 160 No more file descriptors are available for the system.
 161 .RE
 162
 163 .sp
 164 .ne 2
 165 .na
 166 \fB\fBEOPNOTSUPP\fR\fR
 167 .ad
 168 .RS 19n
 169 The specified protocol does not permit creation of socket pairs.
 170 .RE
 171
 172 .sp
 173 .ne 2
 174 .na
 175 \fB\fBEPROTONOSUPPORT\fR\fR
 176 .ad
 177 .RS 19n
 178 The protocol is not supported by the address family, or the protocol is not
 179 supported by the implementation.
 180 .RE
 181
 182 .sp
 183 .ne 2
 184 .na
 185 \fB\fBEPROTOTYPE\fR\fR
 186 .ad
 187 .RS 19n
 188 The socket type is not supported by the protocol.
 189 .RE
 190
 191 .sp
 192 .LP
 193 The \fBsocketpair()\fR function may fail if:
 194 .sp
 195 .ne 2
 196 .na
 197 \fB\fBEACCES\fR\fR
 198 .ad
 199 .RS 11n
 200 The process does not have appropriate privileges.
 201 .RE
 202
 203 .sp
 204 .ne 2
 205 .na
 206 \fB\fBENOBUFS\fR\fR
 207 .ad
 208 .RS 11n
 209 Insufficient resources were available in the system to perform the operation.
 210 .RE
 211
 212 .sp
 213 .ne 2
 214 .na
 215 \fB\fBENOMEM\fR\fR
 216 .ad
 217 .RS 11n
 218 Insufficient memory was available to fulfill the request.
 219 .RE
 220
 221 .sp
 222 .ne 2
 223 .na
 224 \fB\fBENOSR\fR\fR
 225 .ad
 226 .RS 11n
 227 There were insufficient STREAMS resources available for the operation to
 228 complete.
 229 .RE
 230
 231 .SH ATTRIBUTES
 232 .sp
 233 .LP
 234 See \fBattributes\fR(5) for descriptions of the following attributes:
 235 .sp
 236
 237 .sp
 238 .TS
 239 box;
 240 c | c
 241 l | l .
 242 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 243 _
 244 Interface Stability     Standard
 245 _
 246 MT-Level        MT-Safe
 247 .TE
 248
 249 .SH SEE ALSO
 250 .sp
 251 .LP
 252 \fBsocket\fR(3XNET), \fBattributes\fR(5), \fBstandards\fR(5)