lib/libc/sys/socket.2

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     From: @(#)socket.2      8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd January 5, 2009
  32 .Dt SOCKET 2
  33 .Os
  34 .Sh NAME
  35 .Nm socket
  36 .Nd create an endpoint for communication
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In sys/types.h
  41 .In sys/socket.h
  42 .Ft int
  43 .Fn socket "int domain" "int type" "int protocol"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn socket
  47 system call
  48 creates an endpoint for communication and returns a descriptor.
  49 .Pp
  50 The
  51 .Fa domain
  52 argument specifies a communications domain within which
  53 communication will take place; this selects the protocol family
  54 which should be used.
  55 These families are defined in the include file
  56 .In sys/socket.h .
  57 The currently understood formats are:
  58 .Pp
  59 .Bd -literal -offset indent -compact
  60 PF_LOCAL        Host-internal protocols, formerly called PF_UNIX,
  61 PF_UNIX         Host-internal protocols, deprecated, use PF_LOCAL,
  62 PF_INET         Internet version 4 protocols,
  63 PF_PUP          PUP protocols, like BSP,
  64 PF_APPLETALK    AppleTalk protocols,
  65 PF_ROUTE        Internal Routing protocol,
  66 PF_LINK         Link layer interface,
  67 PF_IPX          Novell Internet Packet eXchange protocol,
  68 PF_RTIP         Help Identify RTIP packets,
  69 PF_PIP          Help Identify PIP packets,
  70 PF_ISDN         Integrated Services Digital Network,
  71 PF_KEY          Internal key-management function,
  72 PF_INET6        Internet version 6 protocols,
  73 PF_NATM         Native ATM access,
  74 PF_ATM          ATM,
  75 PF_NETGRAPH     Netgraph sockets
  76 .Ed
  77 .Pp
  78 The socket has the indicated
  79 .Fa type ,
  80 which specifies the semantics of communication.
  81 Currently
  82 defined types are:
  83 .Pp
  84 .Bd -literal -offset indent -compact
  85 SOCK_STREAM     Stream socket,
  86 SOCK_DGRAM      Datagram socket,
  87 SOCK_RAW        Raw-protocol interface,
  88 SOCK_RDM        Reliably-delivered packet,
  89 SOCK_SEQPACKET  Sequenced packet stream
  90 .Ed
  91 .Pp
  92 A
  93 .Dv SOCK_STREAM
  94 type provides sequenced, reliable,
  95 two-way connection based byte streams.
  96 An out-of-band data transmission mechanism may be supported.
  97 A
  98 .Dv SOCK_DGRAM
  99 socket supports
 100 datagrams (connectionless, unreliable messages of
 101 a fixed (typically small) maximum length).
 102 A
 103 .Dv SOCK_SEQPACKET
 104 socket may provide a sequenced, reliable,
 105 two-way connection-based data transmission path for datagrams
 106 of fixed maximum length; a consumer may be required to read
 107 an entire packet with each read system call.
 108 This facility is protocol specific, and presently unimplemented.
 109 .Dv SOCK_RAW
 110 sockets provide access to internal network protocols and interfaces.
 111 The types
 112 .Dv SOCK_RAW ,
 113 which is available only to the super-user, and
 114 .Dv SOCK_RDM ,
 115 which is planned,
 116 but not yet implemented, are not described here.
 117 .Pp
 118 The
 119 .Fa protocol
 120 argument
 121 specifies a particular protocol to be used with the socket.
 122 Normally only a single protocol exists to support a particular
 123 socket type within a given protocol family.
 124 However, it is possible
 125 that many protocols may exist, in which case a particular protocol
 126 must be specified in this manner.
 127 The protocol number to use is
 128 particular to the
 129 .Dq "communication domain"
 130 in which communication
 131 is to take place; see
 132 .Xr protocols 5 .
 133 .Pp
 134 The
 135 .Fa protocol
 136 argument may be set to zero (0) to request the default
 137 implementation of a socket type for the protocol, if any.
 138 .Pp
 139 Sockets of type
 140 .Dv SOCK_STREAM
 141 are full-duplex byte streams, similar
 142 to pipes.
 143 A stream socket must be in a
 144 .Em connected
 145 state before any data may be sent or received
 146 on it.
 147 A connection to another socket is created with a
 148 .Xr connect 2
 149 system call.
 150 Once connected, data may be transferred using
 151 .Xr read 2
 152 and
 153 .Xr write 2
 154 calls or some variant of the
 155 .Xr send 2
 156 and
 157 .Xr recv 2
 158 functions.
 159 (Some protocol families, such as the Internet family,
 160 support the notion of an
 161 .Dq implied connect ,
 162 which permits data to be sent piggybacked onto a connect operation by
 163 using the
 164 .Xr sendto 2
 165 system call.)
 166 When a session has been completed a
 167 .Xr close 2
 168 may be performed.
 169 Out-of-band data may also be transmitted as described in
 170 .Xr send 2
 171 and received as described in
 172 .Xr recv 2 .
 173 .Pp
 174 The communications protocols used to implement a
 175 .Dv SOCK_STREAM
 176 ensure that data
 177 is not lost or duplicated.
 178 If a piece of data for which the
 179 peer protocol has buffer space cannot be successfully transmitted
 180 within a reasonable length of time, then
 181 the connection is considered broken and calls
 182 will indicate an error with
 183 -1 returns and with
 184 .Er ETIMEDOUT
 185 as the specific code
 186 in the global variable
 187 .Va errno .
 188 The protocols optionally keep sockets
 189 .Dq warm
 190 by forcing transmissions
 191 roughly every minute in the absence of other activity.
 192 An error is then indicated if no response can be
 193 elicited on an otherwise
 194 idle connection for an extended period (e.g.\& 5 minutes).
 195 By default, a
 196 .Dv SIGPIPE
 197 signal is raised if a process sends
 198 on a broken stream, but this behavior may be inhibited via
 199 .Xr setsockopt 2 .
 200 .Pp
 201 .Dv SOCK_SEQPACKET
 202 sockets employ the same system calls
 203 as
 204 .Dv SOCK_STREAM
 205 sockets.
 206 The only difference
 207 is that
 208 .Xr read 2
 209 calls will return only the amount of data requested,
 210 and any remaining in the arriving packet will be discarded.
 211 .Pp
 212 .Dv SOCK_DGRAM
 213 and
 214 .Dv SOCK_RAW
 215 sockets allow sending of datagrams to correspondents
 216 named in
 217 .Xr send 2
 218 calls.
 219 Datagrams are generally received with
 220 .Xr recvfrom 2 ,
 221 which returns the next datagram with its return address.
 222 .Pp
 223 An
 224 .Xr fcntl 2
 225 system call can be used to specify a process group to receive
 226 a
 227 .Dv SIGURG
 228 signal when the out-of-band data arrives.
 229 It may also enable non-blocking I/O
 230 and asynchronous notification of I/O events
 231 via
 232 .Dv SIGIO .
 233 .Pp
 234 The operation of sockets is controlled by socket level
 235 .Em options .
 236 These options are defined in the file
 237 .In sys/socket.h .
 238 The
 239 .Xr setsockopt 2
 240 and
 241 .Xr getsockopt 2
 242 system calls are used to set and get options, respectively.
 243 .Sh RETURN VALUES
 244 A -1 is returned if an error occurs, otherwise the return
 245 value is a descriptor referencing the socket.
 246 .Sh ERRORS
 247 The
 248 .Fn socket
 249 system call fails if:
 250 .Bl -tag -width Er
 251 .It Bq Er EPROTONOSUPPORT
 252 The protocol type or the specified protocol is not supported
 253 within this domain.
 254 .It Bq Er EMFILE
 255 The per-process descriptor table is full.
 256 .It Bq Er ENFILE
 257 The system file table is full.
 258 .It Bq Er EACCES
 259 Permission to create a socket of the specified type and/or protocol
 260 is denied.
 261 .It Bq Er ENOBUFS
 262 Insufficient buffer space is available.
 263 The socket cannot be created until sufficient resources are freed.
 264 .It Bq Er EPERM
 265 User has insufficient privileges to carry out the requested operation.
 266 .El
 267 .Sh SEE ALSO
 268 .Xr accept 2 ,
 269 .Xr bind 2 ,
 270 .Xr connect 2 ,
 271 .Xr getpeername 2 ,
 272 .Xr getsockname 2 ,
 273 .Xr getsockopt 2 ,
 274 .Xr ioctl 2 ,
 275 .Xr listen 2 ,
 276 .Xr read 2 ,
 277 .Xr recv 2 ,
 278 .Xr select 2 ,
 279 .Xr send 2 ,
 280 .Xr shutdown 2 ,
 281 .Xr socketpair 2 ,
 282 .Xr write 2 ,
 283 .Xr getprotoent 3 ,
 284 .Xr netgraph 4 ,
 285 .Xr protocols 5
 286 .Rs
 287 .%T "An Introductory 4.3 BSD Interprocess Communication Tutorial"
 288 .%B PS1
 289 .%N 7
 290 .Re
 291 .Rs
 292 .%T "BSD Interprocess Communication Tutorial"
 293 .%B PS1
 294 .%N 8
 295 .Re
 296 .Sh HISTORY
 297 The
 298 .Fn socket
 299 system call appeared in
 300 .Bx 4.2 .