Mercurial > hg > nginx-site

comparison xml/en/docs/stream/ngx_stream_zone_sync_module.xml @ 2142:ca7568f67dee

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Sorted directives alphabetically.
author Ruslan Ermilov <ru@nginx.com>
date Tue, 10 Apr 2018 18:39:34 +0300
parents acef9537383c
children 5a31c6b83cbc
comparison
equal deleted inserted replaced
2141:10751277a8ad 2142:ca7568f67dee
109 </para> 109 </para>
110 110
111 </directive> 111 </directive>
112 112
113 113
114 <directive name="zone_sync_buffers">
115 <syntax><value>number</value> <value>size</value></syntax>
116 <default>256 4k|8k</default>
117 <context>stream</context>
118 <context>server</context>
119
120 <para>
121 Sets the <value>number</value> and <value>size</value> of the
122 per-zone buffers used for pushing zone contents.
123 By default, the buffer size is equal to one memory page.
124 This is either 4K or 8K, depending on a platform.
125 </para>
126
127 </directive>
128
129
130 <directive name="zone_sync_connect_retry_interval">
131 <syntax><value>time</value></syntax>
132 <default>1s</default>
133 <context>stream</context>
134 <context>server</context>
135
136 <para>
137 Defines an interval between connection attempts to another cluster node.
138 </para>
139
140 </directive>
141
142
143 <directive name="zone_sync_connect_timeout">
144 <syntax><value>time</value></syntax>
145 <default>5s</default>
146 <context>stream</context>
147 <context>server</context>
148
149 <para>
150 Defines a timeout for establishing a connection with another cluster node.
151 </para>
152
153 </directive>
154
155
156 <directive name="zone_sync_interval">
157 <syntax><value>time</value></syntax>
158 <default>1s</default>
159 <context>stream</context>
160 <context>server</context>
161
162 <para>
163 Defines an interval for polling updates in a shared memory zone.
164 </para>
165
166 </directive>
167
168
169 <directive name="zone_sync_recv_buffer_size">
170 <syntax><value>size</value></syntax>
171 <default>4k|8k</default>
172 <context>stream</context>
173 <context>server</context>
174
175 <para>
176 Sets <value>size</value> of a per-connection receive buffer used to parse
177 incoming stream of synchronization messages.
178 By default, the buffer size is equal to one memory page.
179 This is either 4K or 8K, depending on a platform.
180 </para>
181
182 </directive>
183
184
114 <directive name="zone_sync_server"> 185 <directive name="zone_sync_server">
115 <syntax><value>address</value> [<literal>resolve</literal>]</syntax> 186 <syntax><value>address</value> [<literal>resolve</literal>]</syntax>
116 <default></default> 187 <default></default>
117 <context>server</context> 188 <context>server</context>
118 189
160 </note> 231 </note>
161 <note> 232 <note>
162 The own address of a node is ignored, thus, there is no need to have different 233 The own address of a node is ignored, thus, there is no need to have different
163 configurations on different nodes. 234 configurations on different nodes.
164 </note> 235 </note>
165 </para>
166
167 </directive>
168
169
170 <directive name="zone_sync_interval">
171 <syntax><value>time</value></syntax>
172 <default>1s</default>
173 <context>stream</context>
174 <context>server</context>
175
176 <para>
177 Defines an interval for polling updates in a shared memory zone.
178 </para>
179
180 </directive>
181
182
183 <directive name="zone_sync_connect_timeout">
184 <syntax><value>time</value></syntax>
185 <default>5s</default>
186 <context>stream</context>
187 <context>server</context>
188
189 <para>
190 Defines a timeout for establishing a connection with another cluster node.
191 </para>
192
193 </directive>
194
195
196 <directive name="zone_sync_connect_retry_interval">
197 <syntax><value>time</value></syntax>
198 <default>1s</default>
199 <context>stream</context>
200 <context>server</context>
201
202 <para>
203 Defines an interval between connection attempts to another cluster node.
204 </para>
205
206 </directive>
207
208
209 <directive name="zone_sync_timeout">
210 <syntax><value>timeout</value></syntax>
211 <default>5s</default>
212 <context>stream</context>
213 <context>server</context>
214
215 <para>
216 Sets the <value>timeout</value> between two successive
217 read or write operations on connection to another cluster node.
218 If no data is transmitted within this time, the connection is closed.
219 </para>
220
221 </directive>
222
223
224 <directive name="zone_sync_buffers">
225 <syntax><value>number</value> <value>size</value></syntax>
226 <default>256 4k|8k</default>
227 <context>stream</context>
228 <context>server</context>
229
230 <para>
231 Sets the <value>number</value> and <value>size</value> of the
232 per-zone buffers used for pushing zone contents.
233 By default, the buffer size is equal to one memory page.
234 This is either 4K or 8K, depending on a platform.
235 </para>
236
237 </directive>
238
239
240 <directive name="zone_sync_recv_buffer_size">
241 <syntax><value>size</value></syntax>
242 <default>4k|8k</default>
243 <context>stream</context>
244 <context>server</context>
245
246 <para>
247 Sets <value>size</value> of a per-connection receive buffer used to parse
248 incoming stream of synchronization messages.
249 By default, the buffer size is equal to one memory page.
250 This is either 4K or 8K, depending on a platform.
251 </para> 236 </para>
252 237
253 </directive> 238 </directive>
254 239
255 240
401 Sets the verification depth in another cluster server certificates chain. 386 Sets the verification depth in another cluster server certificates chain.
402 </para> 387 </para>
403 388
404 </directive> 389 </directive>
405 390
391
392 <directive name="zone_sync_timeout">
393 <syntax><value>timeout</value></syntax>
394 <default>5s</default>
395 <context>stream</context>
396 <context>server</context>
397
398 <para>
399 Sets the <value>timeout</value> between two successive
400 read or write operations on connection to another cluster node.
401 If no data is transmitted within this time, the connection is closed.
402 </para>
403
404 </directive>
405
406 </section> 406 </section>
407 407
408 408
409 <section id="stream_zone_sync_status" name="API endpoints"> 409 <section id="stream_zone_sync_status" name="API endpoints">
410 <para> 410 <para>