Mercurial > hg > nginx-site

comparison xml/ru/docs/stream/ngx_stream_js_module.xml @ 2175:cd4889fdcfa4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Moved njs HTTP and Stream API to a separate page.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 05 Jun 2018 18:22:00 +0300
parents 6c7841469ec5
children 523dc4cc8745
comparison
equal deleted inserted replaced
2174:3b782a679237 2175:cd4889fdcfa4
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Модуль ngx_stream_js_module" 9 <module name="Модуль ngx_stream_js_module"
10 link="/ru/docs/stream/ngx_stream_js_module.html" 10 link="/ru/docs/stream/ngx_stream_js_module.html"
11 lang="ru" 11 lang="ru"
12 rev="10"> 12 rev="11">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 Модуль <literal>ngx_stream_js_module</literal> позволяет задавать 17 Модуль <literal>ngx_stream_js_module</literal> позволяет задавать
229 229
230 </section> 230 </section>
231 231
232 232
233 <section id="properties" name="Свойства объекта сессии"> 233 <section id="properties" name="Свойства объекта сессии">
234 <para> 234
235 Каждый stream-обработчик njs получает один аргумент: 235 <para>
236 объект stream-сессии. 236 Каждый stream-обработчик njs получает один аргумент,
237 </para> 237 <link doc="../njs/njs_api.xml" id="stream_session">объект</link> stream-сессии.
238
239 <para>
240 Объект сессии имеет следующие свойства:
241
242 <list type="tag">
243
244 <tag-name><literal>remoteAddress</literal></tag-name>
245 <tag-desc>
246 адрес клиента, только чтение
247 </tag-desc>
248
249 <tag-name><literal>eof</literal></tag-name>
250 <tag-desc>
251 логическое свойство,
252 true, если текущий буфер является последним буфером,
253 только чтение
254 </tag-desc>
255
256 <tag-name><literal>fromUpstream</literal></tag-name>
257 <tag-desc>
258 логическое свойство,
259 true, если текущий буфер является буфером от проксируемого сервера к клиенту,
260 только чтение
261 </tag-desc>
262
263 <tag-name><literal>buffer</literal></tag-name>
264 <tag-desc>
265 текущий буфер, доступен для записи
266 </tag-desc>
267
268 <tag-name><literal>variables{}</literal></tag-name>
269 <tag-desc>
270 объект переменных nginx, только чтение
271 </tag-desc>
272
273 <tag-name><literal>OK</literal></tag-name>
274 <tag-desc>
275 код <literal>OK</literal>
276 </tag-desc>
277
278 <tag-name><literal>DECLINED</literal></tag-name>
279 <tag-desc>
280 код <literal>DECLINED</literal>
281 </tag-desc>
282
283 <tag-name><literal>AGAIN</literal></tag-name>
284 <tag-desc>
285 код <literal>AGAIN</literal>
286 </tag-desc>
287
288 <tag-name><literal>ERROR</literal></tag-name>
289 <tag-desc>
290 код <literal>ERROR</literal>
291 </tag-desc>
292
293 <tag-name><literal>ABORT</literal></tag-name>
294 <tag-desc>
295 код <literal>ABORT</literal>
296 </tag-desc>
297 </list>
298 </para>
299
300 <para>
301 Объект сессии имеет следующие методы:
302
303 <list type="tag">
304
305 <tag-name><literal>log(<value>строка</value>)</literal></tag-name>
306 <tag-desc>
307 записывает отправленную <value>строку</value> в лог-файл ошибок
308 на уровне лога <literal>info</literal>
309 </tag-desc>
310 </list>
311 </para> 238 </para>
312 239
313 </section> 240 </section>
314 241
315 </module> 242 </module>