Mercurial > hg > nginx-site
diff xml/en/docs/stream/ngx_stream_return_module.xml @ 1746:4d6ea4d94e20
Documented the return module in stream.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Tue, 05 Jul 2016 17:58:34 +0300 |
parents | |
children |
line wrap: on
line diff
new file mode 100644 --- /dev/null +++ b/xml/en/docs/stream/ngx_stream_return_module.xml @@ -0,0 +1,54 @@ +<?xml version="1.0"?> + +<!-- + Copyright (C) Nginx, Inc. + --> + +<!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> + +<module name="Module ngx_stream_return_module" + link="/en/docs/stream/ngx_stream_return_module.html" + lang="en" + rev="1"> + +<section id="summary"> + +<para> +The <literal>ngx_stream_return_module</literal> module (1.11.2) allows +sending a specified value to the client and then closing the connection. +</para> + +</section> + + +<section id="example" name="Example Configuration"> + +<para> +<example> +server { + listen 12345; + return $time_iso8601; +} +</example> +</para> + +</section> + + +<section id="directives" name="Directives"> + +<directive name="return"> +<syntax><value>value</value></syntax> +<default/> +<context>server</context> + +<para> +Specifies a <value>value</value> to send to the client. +The value can contain text, variables, and their combination. +</para> + +</directive> + +</section> + +</module>