lib/libc/sys/accept.2

   1 .\" Copyright (c) 1983, 1990, 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 .\"     @(#)accept.2    8.2 (Berkeley) 12/11/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd March 26, 2013
  32 .Dt ACCEPT 2
  33 .Os
  34 .Sh NAME
  35 .Nm accept
  36 .Nd accept a connection on a socket
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In sys/types.h
  41 .In sys/socket.h
  42 .Ft int
  43 .Fn accept "int s" "struct sockaddr * restrict addr" "socklen_t * restrict addrlen"
  44 .Sh DESCRIPTION
  45 The argument
  46 .Fa s
  47 is a socket that has been created with
  48 .Xr socket 2 ,
  49 bound to an address with
  50 .Xr bind 2 ,
  51 and is listening for connections after a
  52 .Xr listen 2 .
  53 The
  54 .Fn accept
  55 system call extracts the first connection request on the
  56 queue of pending connections, creates a new socket,
  57 and allocates a new file descriptor for the socket which
  58 inherits the state of the
  59 .Dv O_NONBLOCK
  60 and
  61 .Dv O_ASYNC
  62 properties and the destination of
  63 .Dv SIGIO
  64 and
  65 .Dv SIGURG
  66 signals from the original socket
  67 .Fa s .
  68 .Pp
  69 If no pending connections are
  70 present on the queue, and the original socket
  71 is not marked as non-blocking,
  72 .Fn accept
  73 blocks the caller until a connection is present.
  74 If the original socket
  75 is marked non-blocking and no pending
  76 connections are present on the queue,
  77 .Fn accept
  78 returns an error as described below.
  79 The accepted socket
  80 may not be used
  81 to accept more connections.
  82 The original socket
  83 .Fa s
  84 remains open.
  85 .Pp
  86 The argument
  87 .Fa addr
  88 is a result argument that is filled-in with
  89 the address of the connecting entity,
  90 as known to the communications layer.
  91 The exact format of the
  92 .Fa addr
  93 argument is determined by the domain in which the communication
  94 is occurring.
  95 A null pointer may be specified for
  96 .Fa addr
  97 if the address information is not desired;
  98 in this case,
  99 .Fa addrlen
 100 is not used and should also be null.
 101 Otherwise, the
 102 .Fa addrlen
 103 argument
 104 is a value-result argument; it should initially contain the
 105 amount of space pointed to by
 106 .Fa addr ;
 107 on return it will contain the actual length (in bytes) of the
 108 address returned.
 109 This call
 110 is used with connection-based socket types, currently with
 111 .Dv SOCK_STREAM .
 112 .Pp
 113 It is possible to
 114 .Xr select 2
 115 a socket for the purposes of doing an
 116 .Fn accept
 117 by selecting it for read.
 118 .Pp
 119 For certain protocols which require an explicit confirmation,
 120 such as
 121 .Tn ISO
 122 or
 123 .Tn DATAKIT ,
 124 .Fn accept
 125 can be thought of
 126 as merely dequeueing the next connection
 127 request and not implying confirmation.
 128 Confirmation can be implied by a normal read or write on the new
 129 file descriptor, and rejection can be implied by closing the
 130 new socket.
 131 .Pp
 132 For some applications, performance may be enhanced by using an
 133 .Xr accept_filter 9
 134 to pre-process incoming connections.
 135 .Pp
 136 Portable programs should not rely on the
 137 .Dv O_NONBLOCK
 138 and
 139 .Dv O_ASYNC
 140 properties and the signal destination being inherited,
 141 but should set them explicitly using
 142 .Xr fcntl 2 .
 143 .Sh RETURN VALUES
 144 The call returns \-1 on error.
 145 If it succeeds, it returns a non-negative
 146 integer that is a descriptor for the accepted socket.
 147 .Sh ERRORS
 148 The
 149 .Fn accept
 150 system call will fail if:
 151 .Bl -tag -width Er
 152 .It Bq Er EBADF
 153 The descriptor is invalid.
 154 .It Bq Er EINTR
 155 The
 156 .Fn accept
 157 operation was interrupted.
 158 .It Bq Er EMFILE
 159 The per-process descriptor table is full.
 160 .It Bq Er ENFILE
 161 The system file table is full.
 162 .It Bq Er ENOTSOCK
 163 The descriptor references a file, not a socket.
 164 .It Bq Er EINVAL
 165 .Xr listen 2
 166 has not been called on the socket descriptor.
 167 .It Bq Er EINVAL
 168 The
 169 .Fa addrlen
 170 argument is negative.
 171 .It Bq Er EFAULT
 172 The
 173 .Fa addr
 174 argument is not in a writable part of the
 175 user address space.
 176 .It Bq Er EWOULDBLOCK
 177 The socket is marked non-blocking and no connections
 178 are present to be accepted.
 179 .It Bq Er ECONNABORTED
 180 A connection arrived, but it was closed while waiting
 181 on the listen queue.
 182 .El
 183 .Sh SEE ALSO
 184 .Xr bind 2 ,
 185 .Xr connect 2 ,
 186 .Xr getpeername 2 ,
 187 .Xr getsockname 2 ,
 188 .Xr listen 2 ,
 189 .Xr select 2 ,
 190 .Xr socket 2 ,
 191 .Xr accept_filter 9
 192 .Sh HISTORY
 193 The
 194 .Fn accept
 195 system call appeared in
 196 .Bx 4.2 .