Mercurial > hg > nginx-site

annotate xml/en/docs/stream/ngx_stream_core_module.xml @ 1963:351cefd5ff9c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented rcvbuf and sndbuf for mail and stream listen directive.
author Yaroslav Zhuravlev <yar@nginx.com>
date Thu, 13 Apr 2017 15:09:13 +0300
parents f024ac0ec5c7
children b19d5d47c16c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
2
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
3 <!--
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
4 Copyright (C) Nginx, Inc.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
5 -->
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
6
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
8
1405
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
9 <module name="Module ngx_stream_core_module"
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
10 link="/en/docs/stream/ngx_stream_core_module.html"
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
11 lang="en"
1963
351cefd5ff9c Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
12 rev="23">
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
13
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14 <section id="summary">
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16 <para>
1462
e69e4dbcc760 Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents: 1450
diff changeset
17 The <literal>ngx_stream_core_module</literal> module
e69e4dbcc760 Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents: 1450
diff changeset
18 is available since version 1.9.0.
e69e4dbcc760 Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents: 1450
diff changeset
19 This module is not built by default, it should be enabled with the
e69e4dbcc760 Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents: 1450
diff changeset
20 <literal>--with-stream</literal>
e69e4dbcc760 Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents: 1450
diff changeset
21 configuration parameter.
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
22 </para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
23
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24 </section>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
25
1394
66f227952864 Somewhat revamped the stream module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
26
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27 <section id="example" name="Example Configuration">
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
29 <para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
30 <example>
1405
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
31 worker_processes auto;
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
32
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
33 error_log /var/log/nginx/error.log info;
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
34
1528
3ae5301ea37a Added the "events" section to examples of stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1507
diff changeset
35 events {
3ae5301ea37a Added the "events" section to examples of stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1507
diff changeset
36 worker_connections 1024;
3ae5301ea37a Added the "events" section to examples of stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1507
diff changeset
37 }
3ae5301ea37a Added the "events" section to examples of stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1507
diff changeset
38
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
39 stream {
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
40 upstream backend {
1405
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
41 hash $remote_addr consistent;
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
42
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
43 server backend1.example.com:12345 weight=5;
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
44 server 127.0.0.1:12345 max_fails=3 fail_timeout=30s;
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
45 server unix:/tmp/backend3;
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
46 }
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47
1662
48615cf80e20 Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1546
diff changeset
48 upstream dns {
48615cf80e20 Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1546
diff changeset
49 server 192.168.0.1:53535;
48615cf80e20 Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1546
diff changeset
50 server dns.example.com:53;
48615cf80e20 Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1546
diff changeset
51 }
48615cf80e20 Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1546
diff changeset
52
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
53 server {
1405
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
54 listen 12345;
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
55 proxy_connect_timeout 1s;
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
56 proxy_timeout 3s;
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57 proxy_pass backend;
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
58 }
1405
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
59
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
60 server {
1662
48615cf80e20 Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1546
diff changeset
61 listen 127.0.0.1:53 udp;
48615cf80e20 Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1546
diff changeset
62 proxy_responses 1;
48615cf80e20 Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1546
diff changeset
63 proxy_timeout 20s;
48615cf80e20 Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1546
diff changeset
64 proxy_pass dns;
48615cf80e20 Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1546
diff changeset
65 }
48615cf80e20 Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1546
diff changeset
66
48615cf80e20 Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1546
diff changeset
67 server {
1405
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
68 listen [::1]:12345;
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
69 proxy_pass unix:/tmp/stream.socket;
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
70 }
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
71 }
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
72 </example>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
73 </para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
74
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
75 </section>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
76
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
77
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
78 <section id="directives" name="Directives">
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
79
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
80 <directive name="listen">
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
81 <syntax>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
82 <value>address</value>:<value>port</value>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
83 [<literal>ssl</literal>]
1662
48615cf80e20 Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1546
diff changeset
84 [<literal>udp</literal>]
1778
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
85 [<literal>proxy_protocol</literal>]
1502
b628e042a15e Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents: 1500
diff changeset
86 [<literal>backlog</literal>=<value>number</value>]
1963
351cefd5ff9c Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
87 [<literal>rcvbuf</literal>=<value>size</value>]
351cefd5ff9c Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
88 [<literal>sndbuf</literal>=<value>size</value>]
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
89 [<literal>bind</literal>]
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
90 [<literal>ipv6only</literal>=<literal>on</literal>|<literal>off</literal>]
1493
9faa78768252 Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1462
diff changeset
91 [<literal>reuseport</literal>]
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92 [<literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]]</syntax>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
93 <default/>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
94 <context>server</context>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
95
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
96 <para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
97 Sets the <value>address</value> and <value>port</value> for the socket
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
98 on which the server will accept connections.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
99 It is possible to specify just the port.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
100 The address can also be a hostname, for example:
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
101 <example>
1405
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
102 listen 127.0.0.1:12345;
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
103 listen *:12345;
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
104 listen 12345; # same as *:12345
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
105 listen localhost:12345;
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
106 </example>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
107 IPv6 addresses are specified in square brackets:
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
108 <example>
1405
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
109 listen [::1]:12345;
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
110 listen [::]:12345;
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
111 </example>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
112 UNIX-domain sockets are specified with the “<literal>unix:</literal>”
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
113 prefix:
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
114 <example>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
115 listen unix:/var/run/nginx.sock;
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
116 </example>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
117
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
118 </para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
119
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
120 <para>
1462
e69e4dbcc760 Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents: 1450
diff changeset
121 The <literal>ssl</literal> parameter allows specifying that all
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
122 connections accepted on this port should work in SSL mode.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
123 </para>
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
124
1686
93063516f6ff Provided the anchor link for the "listen udp" parameter.
Ruslan Ermilov <ru@nginx.com>
parents: 1662
diff changeset
125 <para id="udp">
1662
48615cf80e20 Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1546
diff changeset
126 The <literal>udp</literal> parameter configures a listening socket
48615cf80e20 Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1546
diff changeset
127 for working with datagrams (1.9.13).
48615cf80e20 Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1546
diff changeset
128 </para>
48615cf80e20 Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1546
diff changeset
129
1778
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
130 <para id="proxy_protocol">
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
131 The <literal>proxy_protocol</literal> parameter (1.11.4)
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
132 allows specifying that all connections accepted on this port should use the
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
133 <link url="http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt">PROXY
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
134 protocol</link>.
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
135 </para>
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
136
1662
48615cf80e20 Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1546
diff changeset
137 <para>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
138 The <literal>listen</literal> directive
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
139 can have several additional parameters specific to socket-related system calls.
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
140 <list type="tag">
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
141
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
142 <tag-name>
1502
b628e042a15e Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents: 1500
diff changeset
143 <literal>backlog</literal>=<value>number</value>
b628e042a15e Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents: 1500
diff changeset
144 </tag-name>
b628e042a15e Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents: 1500
diff changeset
145 <tag-desc>
b628e042a15e Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents: 1500
diff changeset
146 sets the <literal>backlog</literal> parameter in the
b628e042a15e Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents: 1500
diff changeset
147 <c-func>listen</c-func> call that limits
b628e042a15e Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents: 1500
diff changeset
148 the maximum length for the queue of pending connections (1.9.2).
b628e042a15e Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents: 1500
diff changeset
149 By default,
1911
f024ac0ec5c7 Apple rebranded Mac OS X to macOS.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1798
diff changeset
150 <literal>backlog</literal> is set to -1 on FreeBSD, DragonFly BSD, and macOS,
1502
b628e042a15e Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents: 1500
diff changeset
151 and to 511 on other platforms.
b628e042a15e Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents: 1500
diff changeset
152 </tag-desc>
b628e042a15e Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents: 1500
diff changeset
153
b628e042a15e Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents: 1500
diff changeset
154 <tag-name>
1963
351cefd5ff9c Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
155 <literal>rcvbuf</literal>=<value>size</value>
351cefd5ff9c Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
156 </tag-name>
351cefd5ff9c Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
157 <tag-desc>
351cefd5ff9c Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
158 sets the receive buffer size
351cefd5ff9c Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
159 (the <c-def>SO_RCVBUF</c-def> option) for the listening socket (1.11.13).
351cefd5ff9c Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
160 </tag-desc>
351cefd5ff9c Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
161
351cefd5ff9c Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
162 <tag-name>
351cefd5ff9c Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
163 <literal>sndbuf</literal>=<value>size</value>
351cefd5ff9c Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
164 </tag-name>
351cefd5ff9c Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
165 <tag-desc>
351cefd5ff9c Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
166 sets the send buffer size
351cefd5ff9c Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
167 (the <c-def>SO_SNDBUF</c-def> option) for the listening socket (1.11.13).
351cefd5ff9c Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
168 </tag-desc>
351cefd5ff9c Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
169
351cefd5ff9c Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
170 <tag-name>
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
171 <literal>bind</literal>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
172 </tag-name>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
173 <tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
174 this parameter instructs to make a separate <c-func>bind</c-func>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
175 call for a given address:port pair.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
176 The fact is that if there are several <literal>listen</literal> directives with
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
177 the same port but different addresses, and one of the
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
178 <literal>listen</literal> directives listens on all addresses
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
179 for the given port (<literal>*:</literal><value>port</value>), nginx will
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
180 <c-func>bind</c-func> only to <literal>*:</literal><value>port</value>.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
181 It should be noted that the <c-func>getsockname</c-func> system call will be
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
182 made in this case to determine the address that accepted the connection.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
183 If the <literal>ipv6only</literal>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
184 or <literal>so_keepalive</literal> parameters
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
185 are used then for a given
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
186 <value>address</value>:<value>port</value> pair
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
187 a separate <c-func>bind</c-func> call will always be made.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
188 </tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
189
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
190 <tag-name>
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
191 <literal>ipv6only</literal>=<literal>on</literal>|<literal>off</literal>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
192 </tag-name>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
193 <tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
194 this parameter determines
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
195 (via the <c-def>IPV6_V6ONLY</c-def> socket option)
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
196 whether an IPv6 socket listening on a wildcard address <literal>[::]</literal>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
197 will accept only IPv6 connections or both IPv6 and IPv4 connections.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
198 This parameter is turned on by default.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
199 It can only be set once on start.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
200 </tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
201
1507
14180fa9a518 Added ids for reuseport, mentioned reuseport in news.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1502
diff changeset
202 <tag-name id="reuseport">
1493
9faa78768252 Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1462
diff changeset
203 <literal>reuseport</literal>
9faa78768252 Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1462
diff changeset
204 </tag-name>
9faa78768252 Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1462
diff changeset
205 <tag-desc>
9faa78768252 Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1462
diff changeset
206 this parameter (1.9.1) instructs to create an individual listening socket
9faa78768252 Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1462
diff changeset
207 for each worker process
9faa78768252 Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1462
diff changeset
208 (using the <c-def>SO_REUSEPORT</c-def> socket option), allowing a kernel
1496
99ce48c8cce3 Corrected the "reuseport" description of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1493
diff changeset
209 to distribute incoming connections between worker processes.
1500
cd534da03d02 Added Linux kernel version in reuseport.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1496
diff changeset
210 This currently works only on Linux 3.9+ and DragonFly BSD.
1493
9faa78768252 Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1462
diff changeset
211 <note>
9faa78768252 Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1462
diff changeset
212 Inappropriate use of this option may have its security
9faa78768252 Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1462
diff changeset
213 <link url="http://man7.org/linux/man-pages/man7/socket.7.html">implications</link>.
9faa78768252 Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1462
diff changeset
214 </note>
9faa78768252 Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1462
diff changeset
215 </tag-desc>
9faa78768252 Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1462
diff changeset
216
9faa78768252 Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1462
diff changeset
217 <tag-name>
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
218 <literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
219 </tag-name>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
220 <tag-desc>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
221 this parameter configures the “TCP keepalive” behavior
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
222 for the listening socket.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
223 If this parameter is omitted then the operating system’s settings will be
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
224 in effect for the socket.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
225 If it is set to the value “<literal>on</literal>”, the
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
226 <c-def>SO_KEEPALIVE</c-def> option is turned on for the socket.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
227 If it is set to the value “<literal>off</literal>”, the
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
228 <c-def>SO_KEEPALIVE</c-def> option is turned off for the socket.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
229 Some operating systems support setting of TCP keepalive parameters on
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
230 a per-socket basis using the <c-def>TCP_KEEPIDLE</c-def>,
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
231 <c-def>TCP_KEEPINTVL</c-def>, and <c-def>TCP_KEEPCNT</c-def> socket options.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
232 On such systems (currently, Linux 2.4+, NetBSD 5+, and
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
233 FreeBSD 9.0-STABLE), they can be configured
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
234 using the <value>keepidle</value>, <value>keepintvl</value>, and
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
235 <value>keepcnt</value> parameters.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
236 One or two parameters may be omitted, in which case the system default setting
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
237 for the corresponding socket option will be in effect.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
238 For example,
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
239 <example>so_keepalive=30m::10</example>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
240 will set the idle timeout (<c-def>TCP_KEEPIDLE</c-def>) to 30 minutes,
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
241 leave the probe interval (<c-def>TCP_KEEPINTVL</c-def>) at its system default,
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
242 and set the probes count (<c-def>TCP_KEEPCNT</c-def>) to 10 probes.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
243 </tag-desc>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
244
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
245 </list>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
246 </para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
247
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
248 <para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
249 Different servers must listen on different
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
250 <value>address</value>:<value>port</value> pairs.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
251 </para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
252
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
253 </directive>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
254
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
255
1798
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
256 <directive name="preread_buffer_size">
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
257 <syntax><value>size</value></syntax>
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
258 <default>16k</default>
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
259 <context>stream</context>
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
260 <context>server</context>
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
261 <appeared-in>1.11.5</appeared-in>
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
262
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
263 <para>
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
264 Specifies a <value>size</value> of the
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
265 <link doc="stream_processing.xml" id="preread_phase">preread</link> buffer.
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
266 </para>
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
267
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
268 </directive>
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
269
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
270
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
271 <directive name="preread_timeout">
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
272 <syntax><value>timeout</value></syntax>
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
273 <default>30s</default>
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
274 <context>stream</context>
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
275 <context>server</context>
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
276 <appeared-in>1.11.5</appeared-in>
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
277
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
278 <para>
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
279 Specifies a <value>timeout</value> of the
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
280 <link doc="stream_processing.xml" id="preread_phase">preread</link> phase.
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
281 </para>
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
282
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
283 </directive>
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
284
59d1f512c3a0 Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1782
diff changeset
285
1782
363249d888e1 Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1780
diff changeset
286 <directive name="proxy_protocol_timeout">
363249d888e1 Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1780
diff changeset
287 <syntax><value>timeout</value></syntax>
363249d888e1 Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1780
diff changeset
288 <default>30s</default>
363249d888e1 Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1780
diff changeset
289 <context>stream</context>
363249d888e1 Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1780
diff changeset
290 <context>server</context>
363249d888e1 Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1780
diff changeset
291 <appeared-in>1.11.4</appeared-in>
363249d888e1 Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1780
diff changeset
292
363249d888e1 Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1780
diff changeset
293 <para>
363249d888e1 Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1780
diff changeset
294 Specifies a <value>timeout</value> for
363249d888e1 Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1780
diff changeset
295 reading the PROXY protocol header to complete.
363249d888e1 Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1780
diff changeset
296 If no entire header is transmitted within this time,
363249d888e1 Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1780
diff changeset
297 the connection is closed.
363249d888e1 Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1780
diff changeset
298 </para>
363249d888e1 Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1780
diff changeset
299
363249d888e1 Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1780
diff changeset
300 </directive>
363249d888e1 Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1780
diff changeset
301
363249d888e1 Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1780
diff changeset
302
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
303 <directive name="resolver">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
304 <syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
305 <value>address</value> ...
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
306 [<literal>valid</literal>=<value>time</value>]
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
307 [<literal>ipv6</literal>=<literal>on</literal>|<literal>off</literal>]</syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
308 <default/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
309 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
310 <context>server</context>
1753
256774f145ac Documented stream resolver and resolver_timeout for opensource.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1742
diff changeset
311 <appeared-in>1.11.3</appeared-in>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
312
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
313 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
314 Configures name servers used to resolve names of upstream servers
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
315 into addresses, for example:
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
316 <example>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
317 resolver 127.0.0.1 [::1]:5353;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
318 </example>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
319 An address can be specified as a domain name or IP address,
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
320 and an optional port.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
321 If port is not specified, the port 53 is used.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
322 Name servers are queried in a round-robin fashion.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
323 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
324
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
325 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
326 By default, nginx will look up both IPv4 and IPv6 addresses while resolving.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
327 If looking up of IPv6 addresses is not desired,
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
328 the <literal>ipv6=off</literal> parameter can be specified.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
329 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
330
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
331 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
332 By default, nginx caches answers using the TTL value of a response.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
333 The optional <literal>valid</literal> parameter allows overriding it:
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
334 <example>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
335 resolver 127.0.0.1 [::1]:5353 valid=30s;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
336 </example>
1462
e69e4dbcc760 Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents: 1450
diff changeset
337 <note>
1753
256774f145ac Documented stream resolver and resolver_timeout for opensource.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1742
diff changeset
338 Before version 1.11.3, this directive was available as part of our
1462
e69e4dbcc760 Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents: 1450
diff changeset
339 <commercial_version>commercial subscription</commercial_version>.
e69e4dbcc760 Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents: 1450
diff changeset
340 </note>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
341 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
342
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
343 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
344
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
345
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
346 <directive name="resolver_timeout">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
347 <syntax><value>time</value></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
348 <default>30s</default>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
349 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
350 <context>server</context>
1753
256774f145ac Documented stream resolver and resolver_timeout for opensource.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1742
diff changeset
351 <appeared-in>1.11.3</appeared-in>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
352
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
353 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
354 Sets a timeout for name resolution, for example:
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
355 <example>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
356 resolver_timeout 5s;
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
357 </example>
1462
e69e4dbcc760 Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents: 1450
diff changeset
358 <note>
1753
256774f145ac Documented stream resolver and resolver_timeout for opensource.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1742
diff changeset
359 Before version 1.11.3, this directive was available as part of our
1462
e69e4dbcc760 Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents: 1450
diff changeset
360 <commercial_version>commercial subscription</commercial_version>.
e69e4dbcc760 Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents: 1450
diff changeset
361 </note>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
362 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
363
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
364 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
365
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1405
diff changeset
366
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
367 <directive name="server">
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
368 <syntax block="yes"/>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
369 <default/>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
370 <context>stream</context>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
371
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
372 <para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
373 Sets the configuration for a server.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
374 </para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
375
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
376 </directive>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
377
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
378
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
379 <directive name="stream">
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
380 <syntax block="yes"/>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
381 <default/>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
382 <context>main</context>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
383
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
384 <para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
385 Provides the configuration file context in which the stream server directives
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
386 are specified.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
387 </para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
388
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
389 </directive>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
390
1546
8ea1813272bb Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1528
diff changeset
391
8ea1813272bb Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1528
diff changeset
392 <directive name="tcp_nodelay">
8ea1813272bb Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1528
diff changeset
393 <syntax><literal>on</literal> | <literal>off</literal></syntax>
8ea1813272bb Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1528
diff changeset
394 <default>on</default>
8ea1813272bb Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1528
diff changeset
395 <context>stream</context>
8ea1813272bb Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1528
diff changeset
396 <context>server</context>
8ea1813272bb Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1528
diff changeset
397 <appeared-in>1.9.4</appeared-in>
8ea1813272bb Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1528
diff changeset
398
8ea1813272bb Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1528
diff changeset
399 <para>
8ea1813272bb Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1528
diff changeset
400 Enables or disables the use of the <c-def>TCP_NODELAY</c-def> option.
8ea1813272bb Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1528
diff changeset
401 The option is enabled for both client and proxied server connections.
8ea1813272bb Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1528
diff changeset
402 </para>
8ea1813272bb Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1528
diff changeset
403
8ea1813272bb Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1528
diff changeset
404 </directive>
8ea1813272bb Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1528
diff changeset
405
1741
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
406
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
407 <directive name="variables_hash_bucket_size">
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
408 <syntax><value>size</value></syntax>
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
409 <default>64</default>
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
410 <context>stream</context>
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
411 <appeared-in>1.11.2</appeared-in>
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
412
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
413 <para>
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
414 Sets the bucket size for the variables hash table.
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
415 The details of setting up hash tables are provided in a separate
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
416 <link doc="../hash.xml">document</link>.
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
417 </para>
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
418
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
419 </directive>
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
420
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
421
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
422 <directive name="variables_hash_max_size">
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
423 <syntax><value>size</value></syntax>
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
424 <default>1024</default>
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
425 <context>stream</context>
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
426 <appeared-in>1.11.2</appeared-in>
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
427
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
428 <para>
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
429 Sets the maximum <value>size</value> of the variables hash table.
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
430 The details of setting up hash tables are provided in a separate
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
431 <link doc="../hash.xml">document</link>.
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
432 </para>
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
433
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
434 </directive>
a99ebc3af3e4 Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1686
diff changeset
435
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
436 </section>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
437
1742
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
438
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
439 <section id="variables" name="Embedded Variables">
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
440
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
441 <para>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
442 The <literal>ngx_stream_core_module</literal> module supports variables
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
443 since 1.11.2.
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
444 <list type="tag">
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
445
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
446 <tag-name id="var_binary_remote_addr"><var>$binary_remote_addr</var></tag-name>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
447 <tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
448 client address in a binary form, value’s length is always 4 bytes
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
449 for IPv4 addresses or 16 bytes for IPv6 addresses
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
450 </tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
451
1768
061b590cbe1a Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1753
diff changeset
452 <tag-name id="var_bytes_received"><var>$bytes_received</var></tag-name>
061b590cbe1a Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1753
diff changeset
453 <tag-desc>
061b590cbe1a Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1753
diff changeset
454 number of bytes received from a client (1.11.4)
061b590cbe1a Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1753
diff changeset
455 </tag-desc>
061b590cbe1a Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1753
diff changeset
456
1742
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
457 <tag-name id="var_bytes_sent"><var>$bytes_sent</var></tag-name>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
458 <tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
459 number of bytes sent to a client
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
460 </tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
461
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
462 <tag-name id="var_connection"><var>$connection</var></tag-name>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
463 <tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
464 connection serial number
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
465 </tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
466
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
467 <tag-name id="var_hostname"><var>$hostname</var></tag-name>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
468 <tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
469 host name
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
470 </tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
471
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
472 <tag-name id="var_msec"><var>$msec</var></tag-name>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
473 <tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
474 current time in seconds with the milliseconds resolution
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
475 </tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
476
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
477 <tag-name id="var_nginx_version"><var>$nginx_version</var></tag-name>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
478 <tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
479 nginx version
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
480 </tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
481
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
482 <tag-name id="var_pid"><var>$pid</var></tag-name>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
483 <tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
484 PID of the worker process
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
485 </tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
486
1768
061b590cbe1a Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1753
diff changeset
487 <tag-name id="var_protocol"><var>$protocol</var></tag-name>
061b590cbe1a Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1753
diff changeset
488 <tag-desc>
061b590cbe1a Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1753
diff changeset
489 protocol used to communicate with the client:
061b590cbe1a Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1753
diff changeset
490 <literal>TCP</literal> or <literal>UDP</literal> (1.11.4)
061b590cbe1a Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1753
diff changeset
491 </tag-desc>
061b590cbe1a Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1753
diff changeset
492
1778
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
493 <tag-name id="var_proxy_protocol_addr"><var>$proxy_protocol_addr</var></tag-name>
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
494 <tag-desc>
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
495 client address from the PROXY protocol header, or an empty string otherwise
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
496 (1.11.4)
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
497 <para>
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
498 The PROXY protocol must be previously enabled by setting the
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
499 <literal>proxy_protocol</literal> parameter
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
500 in the <link id="listen"/> directive.
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
501 </para>
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
502 </tag-desc>
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
503
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
504 <tag-name id="var_proxy_protocol_port"><var>$proxy_protocol_port</var></tag-name>
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
505 <tag-desc>
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
506 client port from the PROXY protocol header, or an empty string otherwise
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
507 (1.11.4)
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
508 <para>
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
509 The PROXY protocol must be previously enabled by setting the
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
510 <literal>proxy_protocol</literal> parameter
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
511 in the <link id="listen"/> directive.
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
512 </para>
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
513 </tag-desc>
1626f1bf164c Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1771
diff changeset
514
1742
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
515 <tag-name id="var_remote_addr"><var>$remote_addr</var></tag-name>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
516 <tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
517 client address
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
518 </tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
519
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
520 <tag-name id="var_remote_port"><var>$remote_port</var></tag-name>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
521 <tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
522 client port
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
523 </tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
524
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
525 <tag-name id="var_server_addr"><var>$server_addr</var></tag-name>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
526 <tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
527 an address of the server which accepted a connection
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
528 <para>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
529 Computing a value of this variable usually requires one system call.
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
530 To avoid a system call, the <link id="listen"/> directives
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
531 must specify addresses and use the <literal>bind</literal> parameter.
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
532 </para>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
533 </tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
534
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
535 <tag-name id="var_server_port"><var>$server_port</var></tag-name>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
536 <tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
537 port of the server which accepted a connection
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
538 </tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
539
1768
061b590cbe1a Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1753
diff changeset
540 <tag-name id="var_session_time"><var>$session_time</var></tag-name>
061b590cbe1a Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1753
diff changeset
541 <tag-desc>
061b590cbe1a Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1753
diff changeset
542 session duration in seconds with a milliseconds resolution
061b590cbe1a Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1753
diff changeset
543 (1.11.4);
061b590cbe1a Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1753
diff changeset
544 </tag-desc>
061b590cbe1a Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1753
diff changeset
545
1771
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
546 <tag-name id="var_status"><var>$status</var></tag-name>
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
547 <tag-desc>
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
548 session status (1.11.4), can be one of the following:
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
549 <list type="tag">
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
550
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
551 <tag-name><literal>200</literal></tag-name>
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
552 <tag-desc>
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
553 session completed successfully
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
554 </tag-desc>
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
555
1780
8df9ba4e56c6 Documented 400 error in stream $status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1778
diff changeset
556 <tag-name><literal>400</literal></tag-name>
8df9ba4e56c6 Documented 400 error in stream $status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1778
diff changeset
557 <tag-desc>
8df9ba4e56c6 Documented 400 error in stream $status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1778
diff changeset
558 client data could not be parsed, for example,
8df9ba4e56c6 Documented 400 error in stream $status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1778
diff changeset
559 the <link id="proxy_protocol">PROXY protocol</link> header
8df9ba4e56c6 Documented 400 error in stream $status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1778
diff changeset
560 </tag-desc>
8df9ba4e56c6 Documented 400 error in stream $status.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1778
diff changeset
561
1771
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
562 <tag-name><literal>403</literal></tag-name>
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
563 <tag-desc>
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
564 access forbidden, for example, when access is limited for
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
565 <link doc="ngx_stream_access_module.xml">certain client addresses</link>
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
566 </tag-desc>
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
567
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
568 <tag-name><literal>500</literal></tag-name>
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
569 <tag-desc>
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
570 internal server error
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
571 </tag-desc>
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
572
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
573 <tag-name><literal>502</literal></tag-name>
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
574 <tag-desc>
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
575 bad gateway, for example,
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
576 if an upstream server could not be selected or reached.
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
577 </tag-desc>
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
578
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
579 <tag-name><literal>503</literal></tag-name>
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
580 <tag-desc>
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
581 service unavailable, for example, when access is limited by the
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
582 <link doc="ngx_stream_limit_conn_module.xml">number of connections</link>
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
583 </tag-desc>
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
584
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
585 </list>
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
586 </tag-desc>
6a30f04a0208 Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1768
diff changeset
587
1742
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
588 <tag-name id="var_time_iso8601"><var>$time_iso8601</var></tag-name>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
589 <tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
590 local time in the ISO 8601 standard format
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
591 </tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
592
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
593 <tag-name id="var_time_local"><var>$time_local</var></tag-name>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
594 <tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
595 local time in the Common Log Format
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
596 </tag-desc>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
597
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
598 </list>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
599 </para>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
600
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
601 </section>
c511b73da3a9 Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1741
diff changeset
602
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
603 </module>