original/man2/listen.2

   1 .\" Copyright (c) 1983, 1991 The Regents of the University of California.
   2 .\" and Copyright (C) 2007, Michael Kerrisk <mtk.manpages@gmail.com>
   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: listen.2,v 1.6 1999/05/18 14:10:32 freitag Exp $
  36 .\"
  37 .\" Modified Fri Jul 23 22:07:54 1993 by Rik Faith <faith@cs.unc.edu>
  38 .\" Modified 950727 by aeb, following a suggestion by Urs Thuermann
  39 .\" <urs@isnogud.escape.de>
  40 .\" Modified Tue Oct 22 08:11:14 EDT 1996 by Eric S. Raymond <esr@thyrsus.com>
  41 .\" Modified 1998 by Andi Kleen
  42 .\" Modified 11 May 2001 by Sam Varshavchik <mrsam@courier-mta.com>
  43 .\"
  44 .\"
  45 .TH LISTEN 2 2008-11-20 "Linux" "Linux Programmer's Manual"
  46 .SH NAME
  47 listen \- listen for connections on a socket
  48 .SH SYNOPSIS
  49 .nf
  50 .BR "#include <sys/types.h>" "          /* See NOTES */"
  51 .br
  52 .B #include <sys/socket.h>
  53 .sp
  54 .BI "int listen(int " sockfd ", int " backlog );
  55 .fi
  56 .SH DESCRIPTION
  57 .BR listen ()
  58 marks the socket referred to by
  59 .I sockfd
  60 as a passive socket, that is, as a socket that will
  61 be used to accept incoming connection requests using
  62 .BR accept (2).
  63
  64 The
  65 .I sockfd
  66 argument is a file descriptor that refers to a socket of type
  67 .B SOCK_STREAM
  68 or
  69 .BR SOCK_SEQPACKET .
  70
  71 The
  72 .I backlog
  73 argument defines the maximum length
  74 to which the queue of pending connections for
  75 .I sockfd
  76 may grow.
  77 If a connection request arrives when the queue is full, the client
  78 may receive an error with an indication of
  79 .B ECONNREFUSED
  80 or, if the underlying protocol supports retransmission, the request may be
  81 ignored so that a later reattempt at connection succeeds.
  82 .SH RETURN VALUE
  83 On success, zero is returned.
  84 On error, \-1 is returned, and
  85 .I errno
  86 is set appropriately.
  87 .SH ERRORS
  88 .TP
  89 .B EADDRINUSE
  90 Another socket is already listening on the same port.
  91 .TP
  92 .B EBADF
  93 The argument
  94 .I sockfd
  95 is not a valid descriptor.
  96 .TP
  97 .B ENOTSOCK
  98 The argument
  99 .I sockfd
 100 is not a socket.
 101 .TP
 102 .B EOPNOTSUPP
 103 The socket is not of a type that supports the
 104 .BR listen ()
 105 operation.
 106 .SH CONFORMING TO
 107 4.4BSD, POSIX.1-2001.
 108 The
 109 .BR listen ()
 110 function call first appeared in 4.2BSD.
 111 .SH NOTES
 112 To accept connections, the following steps are performed:
 113 .RS 4
 114 .IP 1. 4
 115 A socket is created with
 116 .BR socket (2).
 117 .IP 2.
 118 The socket is bound to a local address using
 119 .BR bind (2),
 120 so that other sockets may be
 121 .BR connect (2)ed
 122 to it.
 123 .IP 3.
 124 A willingness to accept incoming connections and a queue limit for incoming
 125 connections are specified with
 126 .BR listen ().
 127 .IP 4.
 128 Connections are accepted with
 129 .BR accept (2).
 130 .RE
 131 .PP
 132 POSIX.1-2001 does not require the inclusion of
 133 .IR <sys/types.h> ,
 134 and this header file is not required on Linux.
 135 However, some historical (BSD) implementations required this header
 136 file, and portable applications are probably wise to include it.
 137
 138 The behavior of the
 139 .I backlog
 140 argument on TCP sockets changed with Linux 2.2.
 141 Now it specifies the queue length for
 142 .I completely
 143 established sockets waiting to be accepted,
 144 instead of the number of incomplete connection requests.
 145 The maximum length of the queue for incomplete sockets
 146 can be set using
 147 .IR /proc/sys/net/ipv4/tcp_max_syn_backlog .
 148 When syncookies are enabled there is no logical maximum
 149 length and this setting is ignored.
 150 See
 151 .BR tcp (7)
 152 for more information.
 153
 154 If the
 155 .I backlog
 156 argument is greater than the value in
 157 .IR /proc/sys/net/core/somaxconn ,
 158 then it is silently truncated to that value;
 159 the default value in this file is 128.
 160 In kernels before 2.4.25, this limit was a hard coded value,
 161 .BR SOMAXCONN ,
 162 with the value 128.
 163 .\" The following is now rather historic information (MTK, Jun 05)
 164 .\" Don't rely on this value in portable applications since BSD
 165 .\" (and some BSD-derived systems) limit the backlog to 5.
 166 .SH EXAMPLE
 167 See
 168 .BR bind (2).
 169 .SH SEE ALSO
 170 .BR accept (2),
 171 .BR bind (2),
 172 .BR connect (2),
 173 .BR socket (2),
 174 .BR socket (7)
 175 .SH COLOPHON
 176 This page is part of release 3.65 of the Linux
 177 .I man-pages
 178 project.
 179 A description of the project,
 180 and information about reporting bugs,
 181 can be found at
 182 \%http://www.kernel.org/doc/man\-pages/.