Mercurial > hg > nginx-site
comparison xml/en/docs/stream/ngx_stream_keyval_module.xml @ 2424:dd3ac7eefeed
Updated docs for the upcoming NGINX Plus release.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Mon, 02 Sep 2019 14:12:20 +0300 |
parents | 9aa6f3f76055 |
children | d58fc33a0830 |
comparison
equal
deleted
inserted
replaced
2423:21f1376238b0 | 2424:dd3ac7eefeed |
---|---|
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> | 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> |
8 | 8 |
9 <module name="Module ngx_stream_keyval_module" | 9 <module name="Module ngx_stream_keyval_module" |
10 link="/en/docs/stream/ngx_stream_keyval_module.html" | 10 link="/en/docs/stream/ngx_stream_keyval_module.html" |
11 lang="en" | 11 lang="en" |
12 rev="4"> | 12 rev="5"> |
13 | 13 |
14 <section id="summary"> | 14 <section id="summary"> |
15 | 15 |
16 <para> | 16 <para> |
17 The <literal>ngx_stream_keyval_module</literal> module (1.13.7) creates variables | 17 The <literal>ngx_stream_keyval_module</literal> module (1.13.7) creates variables |
85 <directive name="keyval_zone"> | 85 <directive name="keyval_zone"> |
86 <syntax> | 86 <syntax> |
87 <literal>zone</literal>=<value>name</value>:<value>size</value> | 87 <literal>zone</literal>=<value>name</value>:<value>size</value> |
88 [<literal>state</literal>=<value>file</value>] | 88 [<literal>state</literal>=<value>file</value>] |
89 [<literal>timeout</literal>=<value>time</value>] | 89 [<literal>timeout</literal>=<value>time</value>] |
90 [<literal>type</literal>=<literal>string</literal>|<literal>ip</literal>] | |
90 [<literal>sync</literal>]</syntax> | 91 [<literal>sync</literal>]</syntax> |
91 <default/> | 92 <default/> |
92 <context>stream</context> | 93 <context>stream</context> |
93 | 94 |
94 <para> | 95 <para> |
105 </para> | 106 </para> |
106 | 107 |
107 <para id="keyval_timeout"> | 108 <para id="keyval_timeout"> |
108 The optional <literal>timeout</literal> parameter (1.15.0) sets | 109 The optional <literal>timeout</literal> parameter (1.15.0) sets |
109 the time after which key-value pairs are removed from the zone. | 110 the time after which key-value pairs are removed from the zone. |
111 </para> | |
112 | |
113 <para id="keyval_type"> | |
114 The optional <literal>type</literal> parameter (1.17.1) specifies | |
115 the type of the key: | |
116 a <literal>string</literal> (default) or <literal>ip</literal>. | |
117 For the <literal>ip</literal> type, | |
118 the key must be the textual representation of an IP address | |
119 specified in CIDR notation. | |
120 In this case, | |
121 an additional index optimized for matching IP addresses and networks is used | |
122 in evaluating a variable. | |
110 </para> | 123 </para> |
111 | 124 |
112 <para id="keyval_sync"> | 125 <para id="keyval_sync"> |
113 The optional <literal>sync</literal> parameter (1.15.0) enables | 126 The optional <literal>sync</literal> parameter (1.15.0) enables |
114 <link doc="ngx_stream_zone_sync_module.xml" id="zone_sync">synchronization</link> | 127 <link doc="ngx_stream_zone_sync_module.xml" id="zone_sync">synchronization</link> |