original/man2/socket.2

   1 '\" t
   2 .\" Copyright (c) 1983, 1991 The Regents of the University of California.
   3 .\" All rights reserved.
   4 .\"
   5 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   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. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"     This product includes software developed by the University of
  17 .\"     California, Berkeley and its contributors.
  18 .\" 4. Neither the name of the University nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\" %%%LICENSE_END
  34 .\"
  35 .\"     $Id: socket.2,v 1.4 1999/05/13 11:33:42 freitag Exp $
  36 .\"
  37 .\" Modified 1993-07-24 by Rik Faith <faith@cs.unc.edu>
  38 .\" Modified 1996-10-22 by Eric S. Raymond <esr@thyrsus.com>
  39 .\" Modified 1998, 1999 by Andi Kleen <ak@muc.de>
  40 .\" Modified 2002-07-17 by Michael Kerrisk <mtk.manpages@gmail.com>
  41 .\" Modified 2004-06-17 by Michael Kerrisk <mtk.manpages@gmail.com>
  42 .\"
  43 .TH SOCKET 2 2009-01-19 "Linux" "Linux Programmer's Manual"
  44 .SH NAME
  45 socket \- create an endpoint for communication
  46 .SH SYNOPSIS
  47 .BR "#include <sys/types.h>" "          /* See NOTES */"
  48 .br
  49 .B #include <sys/socket.h>
  50 .sp
  51 .BI "int socket(int " domain ", int " type ", int " protocol );
  52 .SH DESCRIPTION
  53 .BR socket ()
  54 creates an endpoint for communication and returns a descriptor.
  55 .PP
  56 The
  57 .I domain
  58 argument specifies a communication domain; this selects the protocol
  59 family which will be used for communication.
  60 These families are defined in
  61 .IR <sys/socket.h> .
  62 The currently understood formats include:
  63 .TS
  64 tab(:);
  65 l l l.
  66 Name:Purpose:Man page
  67 T{
  68 .BR AF_UNIX ", " AF_LOCAL
  69 T}:T{
  70 Local communication
  71 T}:T{
  72 .BR unix (7)
  73 T}
  74 T{
  75 .B AF_INET
  76 T}:IPv4 Internet protocols:T{
  77 .BR ip (7)
  78 T}
  79 T{
  80 .B AF_INET6
  81 T}:IPv6 Internet protocols:T{
  82 .BR ipv6 (7)
  83 T}
  84 T{
  85 .B AF_IPX
  86 T}:IPX \- Novell protocols:
  87 T{
  88 .B AF_NETLINK
  89 T}:T{
  90 Kernel user interface device
  91 T}:T{
  92 .BR netlink (7)
  93 T}
  94 T{
  95 .B AF_X25
  96 T}:ITU-T X.25 / ISO-8208 protocol:T{
  97 .BR x25 (7)
  98 T}
  99 T{
 100 .B AF_AX25
 101 T}:T{
 102 Amateur radio AX.25 protocol
 103 T}:
 104 T{
 105 .B AF_ATMPVC
 106 T}:Access to raw ATM PVCs:
 107 T{
 108 .B AF_APPLETALK
 109 T}:Appletalk:T{
 110 .BR ddp (7)
 111 T}
 112 T{
 113 .B AF_PACKET
 114 T}:T{
 115 Low level packet interface
 116 T}:T{
 117 .BR packet (7)
 118 T}
 119 .TE
 120 .PP
 121 The socket has the indicated
 122 .IR type ,
 123 which specifies the communication semantics.
 124 Currently defined types
 125 are:
 126 .TP 16
 127 .B SOCK_STREAM
 128 Provides sequenced, reliable, two-way, connection-based byte streams.
 129 An out-of-band data transmission mechanism may be supported.
 130 .TP
 131 .B SOCK_DGRAM
 132 Supports datagrams (connectionless, unreliable messages of a fixed
 133 maximum length).
 134 .TP
 135 .B SOCK_SEQPACKET
 136 Provides a sequenced, reliable, two-way connection-based data
 137 transmission path for datagrams of fixed maximum length; a consumer is
 138 required to read an entire packet with each input system call.
 139 .TP
 140 .B SOCK_RAW
 141 Provides raw network protocol access.
 142 .TP
 143 .B SOCK_RDM
 144 Provides a reliable datagram layer that does not guarantee ordering.
 145 .TP
 146 .B SOCK_PACKET
 147 Obsolete and should not be used in new programs;
 148 see
 149 .BR packet (7).
 150 .PP
 151 Some socket types may not be implemented by all protocol families;
 152 for example,
 153 .B SOCK_SEQPACKET
 154 is not implemented for
 155 .BR AF_INET .
 156 .PP
 157 Since Linux 2.6.27, the
 158 .I type
 159 argument serves a second purpose:
 160 in addition to specifying a socket type,
 161 it may include the bitwise OR of any of the following values,
 162 to modify the behavior of
 163 .BR socket ():
 164 .TP 16
 165 .B SOCK_NONBLOCK
 166 Set the
 167 .BR O_NONBLOCK
 168 file status flag on the new open file description.
 169 Using this flag saves extra calls to
 170 .BR fcntl (2)
 171 to achieve the same result.
 172 .TP
 173 .B SOCK_CLOEXEC
 174 Set the close-on-exec
 175 .RB ( FD_CLOEXEC )
 176 flag on the new file descriptor.
 177 See the description of the
 178 .B O_CLOEXEC
 179 flag in
 180 .BR open (2)
 181 for reasons why this may be useful.
 182 .PP
 183 The
 184 .I protocol
 185 specifies a particular protocol to be used with the socket.
 186 Normally only a single protocol exists to support a particular
 187 socket type within a given protocol family, in which case
 188 .I protocol
 189 can be specified as 0.
 190 However, it is possible that many protocols may exist, in
 191 which case a particular protocol must be specified in this manner.
 192 The protocol number to use is specific to the \*(lqcommunication domain\*(rq
 193 in which communication is to take place; see
 194 .BR protocols (5).
 195 See
 196 .BR getprotoent (3)
 197 on how to map protocol name strings to protocol numbers.
 198 .PP
 199 Sockets of type
 200 .B SOCK_STREAM
 201 are full-duplex byte streams, similar to pipes.
 202 They do not preserve
 203 record boundaries.
 204 A stream socket must be in
 205 a
 206 .I connected
 207 state before any data may be sent or received on it.
 208 A connection to
 209 another socket is created with a
 210 .BR connect (2)
 211 call.
 212 Once connected, data may be transferred using
 213 .BR read (2)
 214 and
 215 .BR write (2)
 216 calls or some variant of the
 217 .BR send (2)
 218 and
 219 .BR recv (2)
 220 calls.
 221 When a session has been completed a
 222 .BR close (2)
 223 may be performed.
 224 Out-of-band data may also be transmitted as described in
 225 .BR send (2)
 226 and received as described in
 227 .BR recv (2).
 228 .PP
 229 The communications protocols which implement a
 230 .B SOCK_STREAM
 231 ensure that data is not lost or duplicated.
 232 If a piece of data for which
 233 the peer protocol has buffer space cannot be successfully transmitted
 234 within a reasonable length of time, then the connection is considered
 235 to be dead.
 236 When
 237 .B SO_KEEPALIVE
 238 is enabled on the socket the protocol checks in a protocol-specific
 239 manner if the other end is still alive.
 240 A
 241 .B SIGPIPE
 242 signal is raised if a process sends or receives
 243 on a broken stream; this causes naive processes,
 244 which do not handle the signal, to exit.
 245 .B SOCK_SEQPACKET
 246 sockets employ the same system calls as
 247 .B SOCK_STREAM
 248 sockets.
 249 The only difference is that
 250 .BR read (2)
 251 calls will return only the amount of data requested,
 252 and any data remaining in the arriving packet will be discarded.
 253 Also all message boundaries in incoming datagrams are preserved.
 254 .PP
 255 .B SOCK_DGRAM
 256 and
 257 .B SOCK_RAW
 258 sockets allow sending of datagrams to correspondents named in
 259 .BR sendto (2)
 260 calls.
 261 Datagrams are generally received with
 262 .BR recvfrom (2),
 263 which returns the next datagram along with the address of its sender.
 264 .PP
 265 .B SOCK_PACKET
 266 is an obsolete socket type to receive raw packets directly from the
 267 device driver.
 268 Use
 269 .BR packet (7)
 270 instead.
 271 .PP
 272 An
 273 .BR fcntl (2)
 274 .B F_SETOWN
 275 operation can be used to specify a process or process group to receive a
 276 .B SIGURG
 277 signal when the out-of-band data arrives or
 278 .B SIGPIPE
 279 signal when a
 280 .B SOCK_STREAM
 281 connection breaks unexpectedly.
 282 This operation may also be used to set the process or process group
 283 that receives the I/O and asynchronous notification of I/O events via
 284 .BR SIGIO .
 285 Using
 286 .B F_SETOWN
 287 is equivalent to an
 288 .BR ioctl (2)
 289 call with the
 290 .B FIOSETOWN
 291 or
 292 .B SIOCSPGRP
 293 argument.
 294 .PP
 295 When the network signals an error condition to the protocol module (e.g.,
 296 using a ICMP message for IP) the pending error flag is set for the socket.
 297 The next operation on this socket will return the error code of the pending
 298 error.
 299 For some protocols it is possible to enable a per-socket error queue
 300 to retrieve detailed information about the error; see
 301 .B IP_RECVERR
 302 in
 303 .BR ip (7).
 304 .PP
 305 The operation of sockets is controlled by socket level
 306 .IR options .
 307 These options are defined in
 308 .IR <sys/socket.h> .
 309 The functions
 310 .BR setsockopt (2)
 311 and
 312 .BR getsockopt (2)
 313 are used to set and get options, respectively.
 314 .SH RETURN VALUE
 315 On success, a file descriptor for the new socket is returned.
 316 On error, \-1 is returned, and
 317 .I errno
 318 is set appropriately.
 319 .SH ERRORS
 320 .TP
 321 .B EACCES
 322 Permission to create a socket of the specified type and/or protocol
 323 is denied.
 324 .TP
 325 .B EAFNOSUPPORT
 326 The implementation does not support the specified address family.
 327 .TP
 328 .B EINVAL
 329 Unknown protocol, or protocol family not available.
 330 .TP
 331 .B EINVAL
 332 .\" Since Linux 2.6.27
 333 Invalid flags in
 334 .IR type .
 335 .TP
 336 .B EMFILE
 337 Process file table overflow.
 338 .TP
 339 .B ENFILE
 340 The system limit on the total number of open files has been reached.
 341 .TP
 342 .BR ENOBUFS " or " ENOMEM
 343 Insufficient memory is available.
 344 The socket cannot be
 345 created until sufficient resources are freed.
 346 .TP
 347 .B EPROTONOSUPPORT
 348 The protocol type or the specified protocol is not
 349 supported within this domain.
 350 .PP
 351 Other errors may be generated by the underlying protocol modules.
 352 .SH CONFORMING TO
 353 4.4BSD, POSIX.1-2001.
 354
 355 The
 356 .B SOCK_NONBLOCK
 357 and
 358 .B SOCK_CLOEXEC
 359 flags are Linux-specific.
 360
 361 .BR socket ()
 362 appeared in 4.2BSD.
 363 It is generally portable to/from
 364 non-BSD systems supporting clones of the BSD socket layer (including
 365 System V variants).
 366 .SH NOTES
 367 POSIX.1-2001 does not require the inclusion of
 368 .IR <sys/types.h> ,
 369 and this header file is not required on Linux.
 370 However, some historical (BSD) implementations required this header
 371 file, and portable applications are probably wise to include it.
 372
 373 The manifest constants used under 4.x BSD for protocol families
 374 are
 375 .BR PF_UNIX ,
 376 .BR PF_INET ,
 377 and so on, while
 378 .BR AF_UNIX ,
 379 .BR AF_INET ,
 380 and so on are used for address
 381 families.
 382 However, already the BSD man page promises: "The protocol
 383 family generally is the same as the address family", and subsequent
 384 standards use AF_* everywhere.
 385 .SH EXAMPLE
 386 An example of the use of
 387 .BR socket ()
 388 is shown in
 389 .BR getaddrinfo (3).
 390 .SH SEE ALSO
 391 .BR accept (2),
 392 .BR bind (2),
 393 .BR connect (2),
 394 .BR fcntl (2),
 395 .BR getpeername (2),
 396 .BR getsockname (2),
 397 .BR getsockopt (2),
 398 .BR ioctl (2),
 399 .BR listen (2),
 400 .BR read (2),
 401 .BR recv (2),
 402 .BR select (2),
 403 .BR send (2),
 404 .BR shutdown (2),
 405 .BR socketpair (2),
 406 .BR write (2),
 407 .BR getprotoent (3),
 408 .BR ip (7),
 409 .BR socket (7),
 410 .BR tcp (7),
 411 .BR udp (7),
 412 .BR unix (7)
 413
 414 \(lqAn Introductory 4.3BSD Interprocess Communication Tutorial\(rq
 415 and
 416 \(lqBSD Interprocess Communication Tutorial\(rq,
 417 reprinted in
 418 .I UNIX Programmer's Supplementary Documents Volume 1.