Syntax: | listen
|
---|---|
Default: | — |
Context: | server |
Sets the address
and port
for the socket on which the server will accept requests. It is possible to specify just the port. The address can also be a hostname, for example:
listen 127.0.0.1:110; listen *:110; listen 110; # same as *:110 listen localhost:110;
IPv6 addresses (0.7.58) are specified in square brackets:
listen [::1]:110; listen [::]:110;
UNIX-domain sockets (1.3.5) are specified with the “unix:
” prefix:
listen unix:/var/run/nginx.sock;
Different servers must listen on different address
:port
pairs.
The ssl
parameter allows specifying that all connections accepted on this port should work in SSL mode.
The listen
directive can have several additional parameters specific to socket-related system calls.
-
backlog
=number
- sets the
backlog
parameter in thelisten()
call that limits the maximum length for the queue of pending connections (1.9.2). By default,backlog
is set to -1 on FreeBSD, DragonFly BSD, and Mac OS X, and to 511 on other platforms. -
bind
- this parameter instructs to make a separate
bind()
call for a given address:port pair. The fact is that if there are severallisten
directives with the same port but different addresses, and one of thelisten
directives listens on all addresses for the given port (*:
port
), nginx willbind()
only to*:
port
. It should be noted that thegetsockname()
system call will be made in this case to determine the address that accepted the connection. If theipv6only
orso_keepalive
parameters are used then for a givenaddress
:port
pair a separatebind()
call will always be made. -
ipv6only
=on
|off
- this parameter determines (via the
IPV6_V6ONLY
socket option) whether an IPv6 socket listening on a wildcard address[::]
will accept only IPv6 connections or both IPv6 and IPv4 connections. This parameter is turned on by default. It can only be set once on start. -
so_keepalive
=on
|off
|[keepidle
]:[keepintvl
]:[keepcnt
] - this parameter configures the “TCP keepalive” behavior for the listening socket. If this parameter is omitted then the operating system’s settings will be in effect for the socket. If it is set to the value “
on
”, theSO_KEEPALIVE
option is turned on for the socket. If it is set to the value “off
”, theSO_KEEPALIVE
option is turned off for the socket. Some operating systems support setting of TCP keepalive parameters on a per-socket basis using theTCP_KEEPIDLE
,TCP_KEEPINTVL
, andTCP_KEEPCNT
socket options. On such systems (currently, Linux 2.4+, NetBSD 5+, and FreeBSD 9.0-STABLE), they can be configured using thekeepidle
,keepintvl
, andkeepcnt
parameters. One or two parameters may be omitted, in which case the system default setting for the corresponding socket option will be in effect. For example,so_keepalive=30m::10
will set the idle timeout (TCP_KEEPIDLE
) to 30 minutes, leave the probe interval (TCP_KEEPINTVL
) at its system default, and set the probes count (TCP_KEEPCNT
) to 10 probes.
Please login to continue.