changeset 2278:f047bd9403d5

Documented the "proxy_requests" directive.
author Yaroslav Zhuravlev <yar@nginx.com>
date Mon, 19 Nov 2018 21:19:09 +0300
parents 4ad2cf470ed8
children 7ec59c98d7d5
files xml/en/docs/stream/ngx_stream_proxy_module.xml xml/ru/docs/stream/ngx_stream_proxy_module.xml
diffstat 2 files changed, 55 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/stream/ngx_stream_proxy_module.xml
+++ b/xml/en/docs/stream/ngx_stream_proxy_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_proxy_module"
         link="/en/docs/stream/ngx_stream_proxy_module.html"
         lang="en"
-        rev="21">
+        rev="22">
 
 <section id="summary">
 
@@ -250,6 +250,27 @@ protocol</link> for connections to a pro
 </directive>
 
 
+<directive name="proxy_requests">
+<syntax><value>number</value></syntax>
+<default>0</default>
+<context>stream</context>
+<context>server</context>
+<appeared-in>1.15.7</appeared-in>
+
+<para>
+Sets the number of client datagrams at which
+binding between a client and existing UDP stream session is dropped.
+After receiving the specified number of datagrams, next datagram
+from the same client starts a new session.
+The session terminates when all client datagrams are transmitted
+to a proxied server and the expected number of
+<link id="proxy_responses">responses</link> is received,
+or when it reaches a <link id="proxy_timeout">timeout</link>.
+</para>
+
+</directive>
+
+
 <directive name="proxy_responses">
 <syntax><value>number</value></syntax>
 <default/>
@@ -266,6 +287,12 @@ The number serves as a hint for session 
 By default, the number of datagrams is not limited.
 </para>
 
+<para>
+If zero value is specified, no response is expected.
+However, if a response is received and the
+session is still not finished, the response will be handled.
+</para>
+
 </directive>
 
 
--- a/xml/ru/docs/stream/ngx_stream_proxy_module.xml
+++ b/xml/ru/docs/stream/ngx_stream_proxy_module.xml
@@ -9,7 +9,7 @@
 <module name="Модуль ngx_stream_proxy_module"
         link="/ru/docs/stream/ngx_stream_proxy_module.html"
         lang="ru"
-        rev="21">
+        rev="22">
 
 <section id="summary">
 
@@ -252,6 +252,27 @@ PROXY</link> для соединений с проксируемым сервером.
 </directive>
 
 
+<directive name="proxy_requests">
+<syntax><value>число</value></syntax>
+<default>0</default>
+<context>stream</context>
+<context>server</context>
+<appeared-in>1.15.7</appeared-in>
+
+<para>
+Задаёт число датаграмм, полученных от клиента, по достижении которого
+удаляется привязка между клиентом и существующей UDP-сессией.
+После получения указанного количества датаграмм следующая датаграмма,
+полученная от того же клиента, начинает новую сессию.
+Cессия завершится после отправки всех принятых датаграмм
+на проксируемый сервер и
+получения указанного количества <link id="proxy_responses">ответов</link>
+или после <link id="proxy_timeout">таймаута</link>.
+</para>
+
+</directive>
+
+
 <directive name="proxy_responses">
 <syntax><value>число</value></syntax>
 <default/>
@@ -268,6 +289,11 @@ PROXY</link> для соединений с проксируемым сервером.
 По умолчанию количество датаграмм не ограничено.
 </para>
 
+<para>
+Если указано нулевое значение, то ответ не ожидается.
+Однако если ответ получен и сессия ещё не завершилась, то ответ будет обработан.
+</para>
+
 </directive>