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 December 11, 1993
  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 property from the original socket
  61 .Fa s .
  62 .Pp
  63 If no pending connections are
  64 present on the queue, and the original socket
  65 is not marked as non-blocking,
  66 .Fn accept
  67 blocks the caller until a connection is present.
  68 If the original socket
  69 is marked non-blocking and no pending
  70 connections are present on the queue,
  71 .Fn accept
  72 returns an error as described below.
  73 The accepted socket
  74 may not be used
  75 to accept more connections.
  76 The original socket
  77 .Fa s
  78 remains open.
  79 .Pp
  80 The argument
  81 .Fa addr
  82 is a result argument that is filled-in with
  83 the address of the connecting entity,
  84 as known to the communications layer.
  85 The exact format of the
  86 .Fa addr
  87 argument is determined by the domain in which the communication
  88 is occurring.
  89 A null pointer may be specified for
  90 .Fa addr
  91 if the address information is not desired;
  92 in this case,
  93 .Fa addrlen
  94 is not used and should also be null.
  95 Otherwise, the
  96 .Fa addrlen
  97 argument
  98 is a value-result argument; it should initially contain the
  99 amount of space pointed to by
 100 .Fa addr ;
 101 on return it will contain the actual length (in bytes) of the
 102 address returned.
 103 This call
 104 is used with connection-based socket types, currently with
 105 .Dv SOCK_STREAM .
 106 .Pp
 107 It is possible to
 108 .Xr select 2
 109 a socket for the purposes of doing an
 110 .Fn accept
 111 by selecting it for read.
 112 .Pp
 113 For certain protocols which require an explicit confirmation,
 114 such as
 115 .Tn ISO
 116 or
 117 .Tn DATAKIT ,
 118 .Fn accept
 119 can be thought of
 120 as merely dequeueing the next connection
 121 request and not implying confirmation.
 122 Confirmation can be implied by a normal read or write on the new
 123 file descriptor, and rejection can be implied by closing the
 124 new socket.
 125 .Pp
 126 For some applications, performance may be enhanced by using an
 127 .Xr accept_filter 9
 128 to pre-process incoming connections.
 129 .Sh RETURN VALUES
 130 The call returns \-1 on error.
 131 If it succeeds, it returns a non-negative
 132 integer that is a descriptor for the accepted socket.
 133 .Sh ERRORS
 134 The
 135 .Fn accept
 136 system call will fail if:
 137 .Bl -tag -width Er
 138 .It Bq Er EBADF
 139 The descriptor is invalid.
 140 .It Bq Er EINTR
 141 The
 142 .Fn accept
 143 operation was interrupted.
 144 .It Bq Er EMFILE
 145 The per-process descriptor table is full.
 146 .It Bq Er ENFILE
 147 The system file table is full.
 148 .It Bq Er ENOTSOCK
 149 The descriptor references a file, not a socket.
 150 .It Bq Er EINVAL
 151 .Xr listen 2
 152 has not been called on the socket descriptor.
 153 .It Bq Er EINVAL
 154 The
 155 .Fa addrlen
 156 argument is negative.
 157 .It Bq Er EFAULT
 158 The
 159 .Fa addr
 160 argument is not in a writable part of the
 161 user address space.
 162 .It Bq Er EWOULDBLOCK
 163 The socket is marked non-blocking and no connections
 164 are present to be accepted.
 165 .It Bq Er ECONNABORTED
 166 A connection arrived, but it was closed while waiting
 167 on the listen queue.
 168 .El
 169 .Sh SEE ALSO
 170 .Xr bind 2 ,
 171 .Xr connect 2 ,
 172 .Xr getpeername 2 ,
 173 .Xr getsockname 2 ,
 174 .Xr listen 2 ,
 175 .Xr select 2 ,
 176 .Xr socket 2 ,
 177 .Xr accept_filter 9
 178 .Sh HISTORY
 179 The
 180 .Fn accept
 181 system call appeared in
 182 .Bx 4.2 .