Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

listen(3) [linux man page]

LISTEN(P)						     POSIX Programmer's Manual							 LISTEN(P)

NAME
listen - listen for socket connections and limit the queue of incoming connections SYNOPSIS
#include <sys/socket.h> int listen(int socket, int backlog); DESCRIPTION
The listen() function shall mark a connection-mode socket, specified by the socket argument, as accepting connections. The backlog argument provides a hint to the implementation which the implementation shall use to limit the number of outstanding connec- tions in the socket's listen queue. Implementations may impose a limit on backlog and silently reduce the specified value. Normally, a larger backlog argument value shall result in a larger or equal length of the listen queue. Implementations shall support values of back- log up to SOMAXCONN, defined in <sys/socket.h>. The implementation may include incomplete connections in its listen queue. The limits on the number of incomplete connections and completed connections queued may be different. The implementation may have an upper limit on the length of the listen queue-either global or per accepting socket. If backlog exceeds this limit, the length of the listen queue is set to the limit. If listen() is called with a backlog argument value that is less than 0, the function behaves as if it had been called with a backlog argu- ment value of 0. A backlog argument of 0 may allow the socket to accept connections, in which case the length of the listen queue may be set to an implemen- tation-defined minimum value. The socket in use may require the process to have appropriate privileges to use the listen() function. RETURN VALUE
Upon successful completions, listen() shall return 0; otherwise, -1 shall be returned and errno set to indicate the error. ERRORS
The listen() function shall fail if: EBADF The socket argument is not a valid file descriptor. EDESTADDRREQ The socket is not bound to a local address, and the protocol does not support listening on an unbound socket. EINVAL The socket is already connected. ENOTSOCK The socket argument does not refer to a socket. EOPNOTSUPP The socket protocol does not support listen(). The listen() function may fail if: EACCES The calling process does not have the appropriate privileges. EINVAL The socket has been shut down. ENOBUFS Insufficient resources are available in the system to complete the call. The following sections are informative. EXAMPLES
None. APPLICATION USAGE
None. RATIONALE
None. FUTURE DIRECTIONS
None. SEE ALSO
accept() , connect() , socket() , the Base Definitions volume of IEEE Std 1003.1-2001, <sys/socket.h> COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1, 2003 Edition, Standard for Information Technol- ogy -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html . IEEE
/The Open Group 2003 LISTEN(P)

Check Out this Related Man Page

LISTEN(2)						     Linux Programmer's Manual							 LISTEN(2)

NAME
listen - listen for connections on a socket SYNOPSIS
#include <sys/socket.h> int listen(int s, int backlog); DESCRIPTION
To accept connections, a socket is first created with socket(2), a willingness to accept incoming connections and a queue limit for incom- ing connections are specified with listen, and then the connections are accepted with accept(2). The listen call applies only to sockets of type SOCK_STREAM or SOCK_SEQPACKET. The backlog parameter defines the maximum length the queue of pending connections may grow to. If a connection request arrives with the queue full the client may receive an error with an indication of ECONNREFUSED or, if the underlying protocol supports retransmission, the request may be ignored so that retries succeed. NOTES
The behaviour of the backlog parameter on TCP sockets changed with Linux 2.2. Now it specifies the queue length for completely established sockets waiting to be accepted, instead of the number of incomplete connection requests. The maximum length of the queue for incomplete sockets can be set using the tcp_max_syn_backlog sysctl. When syncookies are enabled there is no logical maximum length and this sysctl setting is ignored. See tcp(7) for more information. RETURN VALUE
On success, zero is returned. On error, -1 is returned, and errno is set appropriately. ERRORS
EADDRINUSE Another socket is already listening on the same port. EBADF The argument s is not a valid descriptor. ENOTSOCK The argument s is not a socket. EOPNOTSUPP The socket is not of a type that supports the listen operation. CONFORMING TO
Single Unix, 4.4BSD, POSIX 1003.1g draft. The listen function call first appeared in 4.2BSD. BUGS
If the socket is of type AF_INET, and the backlog argument is greater than the constant SOMAXCONN (128 in Linux 2.0 & 2.2), it is silently truncated to SOMAXCONN. Don't rely on this value in portable applications since BSD (and some BSD-derived systems) limit the backlog to 5. SEE ALSO
accept(2), connect(2), socket(2) BSD Man Page 1993-07-23 LISTEN(2)
Man Page