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 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)accept.2    8.2 (Berkeley) 12/11/93
  33 .\" $FreeBSD: src/lib/libc/sys/accept.2,v 1.10.2.11 2002/05/09 02:24:40 silby Exp $
  34 .\" $DragonFly: src/lib/libc/sys/accept.2,v 1.4 2006/06/25 10:55:51 corecode Exp $
  35 .\"
  36 .Dd December 11, 1993
  37 .Dt ACCEPT 2
  38 .Os
  39 .Sh NAME
  40 .Nm accept
  41 .Nd accept a connection on a socket
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In sys/types.h
  46 .In sys/socket.h
  47 .Ft int
  48 .Fn accept "int s" "struct sockaddr *addr" "socklen_t *addrlen"
  49 .Sh DESCRIPTION
  50 The argument
  51 .Fa s
  52 is a socket that has been created with
  53 .Xr socket 2 ,
  54 bound to an address with
  55 .Xr bind 2 ,
  56 and is listening for connections after a
  57 .Xr listen 2 .
  58 The
  59 .Fn accept
  60 call
  61 extracts the first connection request
  62 on the queue of pending connections, creates
  63 a new socket with the same properties as
  64 .Fa s ,
  65 and allocates a new file descriptor
  66 for the socket.  If no pending connections are
  67 present on the queue, and the socket is not marked
  68 as non-blocking,
  69 .Fn accept
  70 blocks the caller until a connection is present.
  71 If the socket is marked non-blocking and no pending
  72 connections are present on the queue,
  73 .Fn accept
  74 returns an error as described below.
  75 The accepted socket
  76 may not be used
  77 to accept more connections.  The original socket
  78 .Fa s
  79 remains open.
  80 .Pp
  81 The argument
  82 .Fa addr
  83 is a result parameter that is filled-in with
  84 the address of the connecting entity,
  85 as known to the communications layer.
  86 The exact format of the
  87 .Fa addr
  88 parameter is determined by the domain in which the communication
  89 is occurring.
  90 To ensure that the returned address fits,
  91 .Fa *addr
  92 should have a size of at least
  93 .Ft sizeof(struct sockaddr_storage) .
  94 The
  95 .Fa addrlen
  96 is a value-result parameter; it should initially contain the
  97 amount of space pointed to by
  98 .Fa addr ;
  99 on return it will contain the actual length (in bytes) of the
 100 address returned.
 101 This call
 102 is used with connection-based socket types, currently with
 103 .Dv SOCK_STREAM .
 104 .Pp
 105 It is possible to
 106 .Xr select 2
 107 a socket for the purposes of doing an
 108 .Fn accept
 109 by selecting it for read.
 110 .Pp
 111 For certain protocols which require an explicit confirmation,
 112 such as
 113 .Tn ISO
 114 or
 115 .Tn DATAKIT ,
 116 .Fn accept
 117 can be thought of
 118 as merely dequeueing the next connection
 119 request and not implying confirmation.
 120 Confirmation can be implied by a normal read or write on the new
 121 file descriptor, and rejection can be implied by closing the
 122 new socket.
 123 .Pp
 124 For some applications, performance may be enhanced by using an
 125 .Xr accept_filter 9
 126 to pre-process incoming connections.
 127 .Sh RETURN VALUES
 128 The call returns \-1 on error.  If it succeeds, it returns a non-negative
 129 integer that is a descriptor for the accepted socket.
 130 .Sh ERRORS
 131 The
 132 .Fn accept
 133 will fail if:
 134 .Bl -tag -width Er
 135 .It Bq Er EBADF
 136 The descriptor is invalid.
 137 .It Bq Er EINTR
 138 The
 139 .Fn accept
 140 operation was interrupted.
 141 .It Bq Er EMFILE
 142 The per-process descriptor table is full.
 143 .It Bq Er ENFILE
 144 The system file table is full.
 145 .It Bq Er ENOTSOCK
 146 The descriptor references a file, not a socket.
 147 .It Bq Er EINVAL
 148 .Xr listen 2
 149 has not been called on the socket descriptor.
 150 .It Bq Er EFAULT
 151 The
 152 .Fa addr
 153 parameter is not in a writable part of the
 154 user address space.
 155 .It Bq Er EWOULDBLOCK
 156 The socket is marked non-blocking and no connections
 157 are present to be accepted.
 158 .It Bq Er ECONNABORTED
 159 A connection arrived, but it was closed while waiting
 160 on the listen queue.
 161 .El
 162 .Sh SEE ALSO
 163 .Xr bind 2 ,
 164 .Xr connect 2 ,
 165 .Xr getpeername 2 ,
 166 .Xr listen 2 ,
 167 .Xr select 2 ,
 168 .Xr socket 2 ,
 169 .Xr accept_filter 9
 170 .Sh HISTORY
 171 The
 172 .Fn accept
 173 function appeared in
 174 .Bx 4.2 .