lib/libcr/sys/listen.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 .\" 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 .\"     From: @(#)listen.2      8.2 (Berkeley) 12/11/93
  33 .\" $FreeBSD: src/lib/libc/sys/listen.2,v 1.12.2.9 2002/05/09 02:24:40 silby Exp $
  34 .\"
  35 .Dd November 3, 1995
  36 .Dt LISTEN 2
  37 .Os
  38 .Sh NAME
  39 .Nm listen
  40 .Nd listen for connections on a socket
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In sys/types.h
  45 .In sys/socket.h
  46 .Ft int
  47 .Fn listen "int s" "int backlog"
  48 .Sh DESCRIPTION
  49 To accept connections, a socket
  50 is first created with
  51 .Xr socket 2 ,
  52 a willingness to accept incoming connections and
  53 a queue limit for incoming connections are specified with
  54 .Fn listen ,
  55 and then the connections are
  56 accepted with
  57 .Xr accept 2 .
  58 The
  59 .Fn listen
  60 call applies only to sockets of type
  61 .Dv SOCK_STREAM
  62 or
  63 .Dv SOCK_SEQPACKET .
  64 .Pp
  65 The
  66 .Fa backlog
  67 parameter defines the maximum length the queue of
  68 pending connections may grow to.
  69 If a connection
  70 request arrives with the queue full the client may
  71 receive an error with an indication of
  72 .Er ECONNREFUSED ,
  73 or, in the case of TCP, the connection will be
  74 silently dropped.
  75 .Pp
  76 Note that before FreeBSD 4.5 and the introduction of the syncache,
  77 the
  78 .Fa backlog
  79 parameter also determined the length of the incomplete
  80 connection queue, which held TCP sockets in the process
  81 of completing TCP's 3-way handshake.  These incomplete connections
  82 are now held entirely in the syncache, which is unaffected by
  83 queue lengths.  Inflated
  84 .Fa backlog
  85 values to help handle denial
  86 of service attacks are no longer necessary.
  87 .Pp
  88 The
  89 .Xr sysctl 3
  90 MIB variable
  91 .Dq Va kern.ipc.somaxconn
  92 specifies a hard limit on
  93 .Fa backlog ;
  94 if a value greater than
  95 .Va kern.ipc.somaxconn
  96 or less than zero is specified,
  97 .Fa backlog
  98 is silently forced to
  99 .Va kern.ipc.somaxconn .
 100 .Sh INTERACTION WITH ACCEPT FILTERS
 101 When accept filtering is used on a socket, a second queue will
 102 be used to hold sockets that have connected, but have not yet
 103 met their accept filtering criteria.  Once the criteria has been
 104 met, these sockets will be moved over into the completed connection
 105 queue to be accept()ed.  If this secondary queue is full and a
 106 new connection comes in, the oldest socket which has not yet met
 107 its accept filter criteria will be terminated.
 108 .Pp
 109 This secondary queue, like the primary listen queue, is sized
 110 according to the
 111 .Fa backlog
 112 parameter.
 113 .Sh RETURN VALUES
 114 .Rv -std listen
 115 .Sh ERRORS
 116 .Fn Listen
 117 will fail if:
 118 .Bl -tag -width Er
 119 .It Bq Er EBADF
 120 The argument
 121 .Fa s
 122 is not a valid descriptor.
 123 .It Bq Er ENOTSOCK
 124 The argument
 125 .Fa s
 126 is not a socket.
 127 .It Bq Er EOPNOTSUPP
 128 The socket is not of a type that supports the operation
 129 .Fn listen .
 130 .El
 131 .Sh SEE ALSO
 132 .Xr accept 2 ,
 133 .Xr accept_filter 9 ,
 134 .Xr connect 2 ,
 135 .Xr socket 2 ,
 136 .Xr sysctl 3 ,
 137 .Xr sysctl 8
 138 .Sh HISTORY
 139 The
 140 .Fn listen
 141 function call appeared in
 142 .Bx 4.2 .
 143 The ability to configure the maximum
 144 .Fa backlog
 145 at run-time, and to use a negative
 146 .Fa backlog
 147 to request the maximum allowable value, was introduced in
 148 .Fx 2.2 .