Mercurial > hg > nginx-site
comparison 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 |
comparison
equal
deleted
inserted
replaced
1745:0dfb7628bfee | 1746:4d6ea4d94e20 |
---|---|
1 <?xml version="1.0"?> | |
2 | |
3 <!-- | |
4 Copyright (C) Nginx, Inc. | |
5 --> | |
6 | |
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> | |
8 | |
9 <module name="Module ngx_stream_return_module" | |
10 link="/en/docs/stream/ngx_stream_return_module.html" | |
11 lang="en" | |
12 rev="1"> | |
13 | |
14 <section id="summary"> | |
15 | |
16 <para> | |
17 The <literal>ngx_stream_return_module</literal> module (1.11.2) allows | |
18 sending a specified value to the client and then closing the connection. | |
19 </para> | |
20 | |
21 </section> | |
22 | |
23 | |
24 <section id="example" name="Example Configuration"> | |
25 | |
26 <para> | |
27 <example> | |
28 server { | |
29 listen 12345; | |
30 return $time_iso8601; | |
31 } | |
32 </example> | |
33 </para> | |
34 | |
35 </section> | |
36 | |
37 | |
38 <section id="directives" name="Directives"> | |
39 | |
40 <directive name="return"> | |
41 <syntax><value>value</value></syntax> | |
42 <default/> | |
43 <context>server</context> | |
44 | |
45 <para> | |
46 Specifies a <value>value</value> to send to the client. | |
47 The value can contain text, variables, and their combination. | |
48 </para> | |
49 | |
50 </directive> | |
51 | |
52 </section> | |
53 | |
54 </module> |