Mercurial > hg > nginx-site
annotate xml/en/docs/stream/ngx_stream_return_module.xml @ 2670:e53592a1d979
Improved descriptions of s.done, s.allow, s.decline, s.deny.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Fri, 05 Mar 2021 18:22:39 +0000 |
parents | 4d6ea4d94e20 |
children |
rev | line source |
---|---|
1746
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
1 <?xml version="1.0"?> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
2 |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
3 <!-- |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
4 Copyright (C) Nginx, Inc. |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
5 --> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
6 |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
8 |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
9 <module name="Module ngx_stream_return_module" |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
10 link="/en/docs/stream/ngx_stream_return_module.html" |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
11 lang="en" |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
12 rev="1"> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
13 |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
14 <section id="summary"> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
15 |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
16 <para> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
17 The <literal>ngx_stream_return_module</literal> module (1.11.2) allows |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
18 sending a specified value to the client and then closing the connection. |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
19 </para> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
20 |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
21 </section> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
22 |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
23 |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
24 <section id="example" name="Example Configuration"> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
25 |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
26 <para> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
27 <example> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
28 server { |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
29 listen 12345; |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
30 return $time_iso8601; |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
31 } |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
32 </example> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
33 </para> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
34 |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
35 </section> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
36 |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
37 |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
38 <section id="directives" name="Directives"> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
39 |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
40 <directive name="return"> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
41 <syntax><value>value</value></syntax> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
42 <default/> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
43 <context>server</context> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
44 |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
45 <para> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
46 Specifies a <value>value</value> to send to the client. |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
47 The value can contain text, variables, and their combination. |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
48 </para> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
49 |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
50 </directive> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
51 |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
52 </section> |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
53 |
4d6ea4d94e20
Documented the return module in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
54 </module> |