comparison xml/en/docs/stream/ngx_stream_proxy_module.xml @ 2278:f047bd9403d5

Documented the "proxy_requests" directive.
author Yaroslav Zhuravlev <yar@nginx.com>
date Mon, 19 Nov 2018 21:19:09 +0300
parents d765ffffd08c
children d5e576eb7677
comparison
equal deleted inserted replaced
2277:4ad2cf470ed8 2278:f047bd9403d5
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Module ngx_stream_proxy_module" 9 <module name="Module ngx_stream_proxy_module"
10 link="/en/docs/stream/ngx_stream_proxy_module.html" 10 link="/en/docs/stream/ngx_stream_proxy_module.html"
11 lang="en" 11 lang="en"
12 rev="21"> 12 rev="22">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 The <literal>ngx_stream_proxy_module</literal> module (1.9.0) allows proxying 17 The <literal>ngx_stream_proxy_module</literal> module (1.9.0) allows proxying
248 </para> 248 </para>
249 249
250 </directive> 250 </directive>
251 251
252 252
253 <directive name="proxy_requests">
254 <syntax><value>number</value></syntax>
255 <default>0</default>
256 <context>stream</context>
257 <context>server</context>
258 <appeared-in>1.15.7</appeared-in>
259
260 <para>
261 Sets the number of client datagrams at which
262 binding between a client and existing UDP stream session is dropped.
263 After receiving the specified number of datagrams, next datagram
264 from the same client starts a new session.
265 The session terminates when all client datagrams are transmitted
266 to a proxied server and the expected number of
267 <link id="proxy_responses">responses</link> is received,
268 or when it reaches a <link id="proxy_timeout">timeout</link>.
269 </para>
270
271 </directive>
272
273
253 <directive name="proxy_responses"> 274 <directive name="proxy_responses">
254 <syntax><value>number</value></syntax> 275 <syntax><value>number</value></syntax>
255 <default/> 276 <default/>
256 <context>stream</context> 277 <context>stream</context>
257 <context>server</context> 278 <context>server</context>
262 in response to a client datagram 283 in response to a client datagram
263 if the <link doc="ngx_stream_core_module.xml" id="udp">UDP</link> 284 if the <link doc="ngx_stream_core_module.xml" id="udp">UDP</link>
264 protocol is used. 285 protocol is used.
265 The number serves as a hint for session termination. 286 The number serves as a hint for session termination.
266 By default, the number of datagrams is not limited. 287 By default, the number of datagrams is not limited.
288 </para>
289
290 <para>
291 If zero value is specified, no response is expected.
292 However, if a response is received and the
293 session is still not finished, the response will be handled.
267 </para> 294 </para>
268 295
269 </directive> 296 </directive>
270 297
271 298