changeset 2725:6d082b470918

Documented "listen fastopen=" parameter in stream.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 25 May 2021 12:53:00 +0100
parents 00afc7c4d4df
children a7a36efd10af
files xml/en/docs/stream/ngx_stream_core_module.xml xml/ru/docs/stream/ngx_stream_core_module.xml
diffstat 2 files changed, 40 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/stream/ngx_stream_core_module.xml	Thu May 20 19:56:08 2021 +0300
+++ b/xml/en/docs/stream/ngx_stream_core_module.xml	Tue May 25 12:53:00 2021 +0100
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_core_module"
         link="/en/docs/stream/ngx_stream_core_module.html"
         lang="en"
-        rev="33">
+        rev="34">
 
 <section id="summary">
 
@@ -82,6 +82,7 @@
     [<literal>ssl</literal>]
     [<literal>udp</literal>]
     [<literal>proxy_protocol</literal>]
+    [<literal>fastopen</literal>=<value>number</value>]
     [<literal>backlog</literal>=<value>number</value>]
     [<literal>rcvbuf</literal>=<value>size</value>]
     [<literal>sndbuf</literal>=<value>size</value>]
@@ -153,6 +154,24 @@
 <list type="tag">
 
 <tag-name>
+<literal>fastopen</literal>=<value>number</value>
+</tag-name>
+<tag-desc>
+enables
+“<link url="http://en.wikipedia.org/wiki/TCP_Fast_Open">TCP Fast Open</link>”
+for the listening socket (1.21.0) and
+<link url="https://tools.ietf.org/html/rfc7413#section-5.1">limits</link>
+the maximum length for the queue of connections that have not yet completed
+the three-way handshake.
+<note>
+Do not enable this feature unless the server can handle
+receiving the
+<link url="https://tools.ietf.org/html/rfc7413#section-6.1">
+same SYN packet with data</link> more than once.
+</note>
+</tag-desc>
+
+<tag-name>
 <literal>backlog</literal>=<value>number</value>
 </tag-name>
 <tag-desc>
--- a/xml/ru/docs/stream/ngx_stream_core_module.xml	Thu May 20 19:56:08 2021 +0300
+++ b/xml/ru/docs/stream/ngx_stream_core_module.xml	Tue May 25 12:53:00 2021 +0100
@@ -9,7 +9,7 @@
 <module name="Модуль ngx_stream_core_module"
         link="/ru/docs/stream/ngx_stream_core_module.html"
         lang="ru"
-        rev="33">
+        rev="34">
 
 <section id="summary">
 
@@ -82,6 +82,7 @@
     [<literal>ssl</literal>]
     [<literal>udp</literal>]
     [<literal>proxy_protocol</literal>]
+    [<literal>fastopen</literal>=<value>число</value>]
     [<literal>backlog</literal>=<value>число</value>]
     [<literal>rcvbuf</literal>=<value>размер</value>]
     [<literal>sndbuf</literal>=<value>размер</value>]
@@ -154,6 +155,24 @@
 <list type="tag">
 
 <tag-name>
+<literal>fastopen</literal>=<value>число</value>
+</tag-name>
+<tag-desc>
+включает
+“<link url="http://en.wikipedia.org/wiki/TCP_Fast_Open">TCP Fast Open</link>”
+для слушающего сокета (1.21.0) и
+<link url="https://tools.ietf.org/html/rfc7413#section-5.1">ограничивает</link>
+максимальную длину очереди соединений, которые ещё не завершили процесс
+three-way handshake.
+<note>
+Не включайте “TCP Fast Open”, не убедившись, что сервер может адекватно
+обрабатывать многократное получение
+<link url="https://tools.ietf.org/html/rfc7413#section-6.1">
+одного и того же SYN-пакета с данными</link>.
+</note>
+</tag-desc>
+
+<tag-name>
 <literal>backlog</literal>=<value>число</value>
 </tag-name>
 <tag-desc>