Mercurial > hg > nginx-site
diff xml/en/docs/stream/ngx_stream_proxy_module.xml @ 1662:48615cf80e20
Documented the UDP proxy functionality.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Tue, 15 Mar 2016 16:31:42 +0300 |
parents | c4c1dddfedac |
children | d855e7cc3b2f |
line wrap: on
line diff
--- a/xml/en/docs/stream/ngx_stream_proxy_module.xml Tue Mar 15 13:26:18 2016 +0300 +++ b/xml/en/docs/stream/ngx_stream_proxy_module.xml Tue Mar 15 16:31:42 2016 +0300 @@ -9,13 +9,13 @@ <module name="Module ngx_stream_proxy_module" link="/en/docs/stream/ngx_stream_proxy_module.html" lang="en" - rev="12"> + rev="13"> <section id="summary"> <para> -The <literal>ngx_stream_proxy_module</literal> module (1.9.0) allows passing -connections to another server over TCP and UNIX-domain sockets. +The <literal>ngx_stream_proxy_module</literal> module (1.9.0) allows proxying +data streams over TCP, UDP (1.9.13), and UNIX-domain sockets. </para> </section> @@ -38,6 +38,13 @@ } server { + listen 53 udp; + proxy_responses 1; + proxy_timeout 20s; + proxy_pass dns.example.com:53; +} + +server { listen [::1]:12345; proxy_pass unix:/tmp/stream.socket; } @@ -211,6 +218,26 @@ </directive> +<directive name="proxy_responses"> +<syntax><value>number</value></syntax> +<default/> +<context>stream</context> +<context>server</context> +<appeared-in>1.9.13</appeared-in> + +<para> +Sets the number of datagrams expected from the proxied server +in response to the client request +if the <link doc="ngx_stream_core_module.xml" id="udp">UDP</link> +protocol is used. +By default, the number of datagrams is not limited: +the response datagrams will be sent +until the <link id="proxy_timeout"/> value expires. +</para> + +</directive> + + <directive name="proxy_ssl"> <syntax><literal>on</literal> | <literal>off</literal></syntax> <default>off</default>