annotate xml/ru/docs/njs/njs_api.xml @ 2182:7865ca0da0ab

Merged HTTP request,response, and reply in njs.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 19 Jun 2018 15:43:42 +0300
parents cd4889fdcfa4
children 23cfb62121d1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
2
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
3 <!--
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
4 Copyright (C) Nginx, Inc.
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
5 -->
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
6
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
7 <!DOCTYPE article SYSTEM "../../../../dtd/article.dtd">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
8
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
9 <article name="njs API"
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
10 link="/ru/docs/njs/njs_api.html"
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
11 lang="ru"
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
12 rev="1">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
13
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
14 <section id="summary">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
15
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
16 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
17 <link doc="../njs_about.xml">njs</link> предоставляет объекты, методы и свойства
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
18 для расширения функциональности nginx.
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
19 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
20
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
21 </section>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
22
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
23
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
24 <section id="http" name="HTTP">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
25
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
26
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
27 <section id="http_request" name="Запрос">
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
28
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
29 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
30 Объекты <literal>HTTP</literal> доступны только в
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
31 модуле <link doc="../http/ngx_http_js_module.xml">ngx_http_js_module</link>.
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
32 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
33
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
34 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
35 <list type="tag">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
36
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
37 <tag-name><literal>r.args{}</literal></tag-name>
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
38 <tag-desc>
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
39 объект аргументов запроса, только чтение
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
40 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
41
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
42 <tag-name><literal>r.error(<value>строка</value>)</literal></tag-name>
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
43 <tag-desc>
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
44 записывает <literal>строку</literal> в лог-файл ошибок
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
45 на уровне лога <literal>error</literal>
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
46 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
47
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
48 <tag-name><literal>r.finish()</literal></tag-name>
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
49 <tag-desc>
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
50 завершает отправку ответа клиенту
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
51 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
52
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
53 <tag-name><literal>r.headersIn{}</literal></tag-name>
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
54 <tag-desc>
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
55 объект исходящих заголовков, только чтение.
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
56 <para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
57 Например, доступ к заголовку <literal>Header-Name</literal>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
58 можно получить при помощи синтаксиса <literal>headers['Header-Name']</literal>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
59 или <literal>headers.Header_name</literal>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
60 </para>
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
61 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
62
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
63 <tag-name><literal>r.headersOut{}</literal></tag-name>
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
64 <tag-desc>
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
65 объект исходящих заголовков, доступно для записи.
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
66 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
67 Например, доступ к заголовку <literal>Header-Name</literal>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
68 можно получить при помощи синтаксиса <literal>headers['Header-Name']</literal>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
69 или <literal>headers.Header_name</literal>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
70 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
71 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
72
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
73 <tag-name><literal>r.httpVersion</literal></tag-name>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
74 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
75 версия HTTP, только чтение
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
76 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
77
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
78 <tag-name><literal>r.log(<value>строка</value>)</literal></tag-name>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
79 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
80 записывает <literal>строку</literal> в лог-файл ошибок
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
81 на уровне лога <literal>info</literal>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
82 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
83
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
84 <tag-name><literal>r.method</literal></tag-name>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
85 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
86 HTTP метод, только чтение
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
87 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
88
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
89 <tag-name><literal>r.parent</literal></tag-name>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
90 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
91 ссылается на родительский объект запроса
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
92 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
93
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
94 <tag-name><literal>r.remoteAddress</literal></tag-name>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
95 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
96 адрес клиента, только чтение
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
97 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
98
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
99 <tag-name><literal>r.requestBody</literal></tag-name>
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
100 <tag-desc>
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
101 хранит тело запроса, только чтение
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
102 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
103
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
104 <tag-name><literal>r.responseBody</literal></tag-name>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
105 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
106 хранит тело ответа <link id="subrequest">подзапроса</link>, только чтение
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
107 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
108
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
109 <tag-name><literal>r.return(код[, строка])</literal></tag-name>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
110 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
111 отправляет
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
112 клиенту полный ответ с указанным <literal>кодом</literal>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
113 <para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
114 Можно задать или URL перенаправления
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
115 (для кодов 301, 302, 303, 307 и 308),
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
116 или текст тела ответа (для остальных кодов) в качестве второго аргумента
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
117 </para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
118 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
119
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
120 <tag-name><literal>r.send(<value>строка</value>)</literal></tag-name>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
121 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
122 отправляет часть тела ответа клиенту
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
123 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
124
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
125 <tag-name><literal>r.sendHeader()</literal></tag-name>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
126 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
127 отправляет заголовок HTTP клиенту
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
128 </tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
129
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
130 <tag-name><literal>r.status</literal></tag-name>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
131 <tag-desc>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
132 статус, доступно для записи
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
133 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
134
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
135 <tag-name><literal>req.variables{}</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
136 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
137 объект переменных nginx, только чтение
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
138 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
139
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
140 <tag-name><literal>r.warn(<value>строка</value>)</literal></tag-name>
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
141 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
142 записывает <literal>строку</literal> в лог-файл ошибок
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
143 на уровне лога <literal>warning</literal>
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
144 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
145
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
146 <tag-name><literal>r.uri</literal></tag-name>
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
147 <tag-desc>
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
148 текущий URI, только чтение
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
149 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
150
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
151 <tag-name id="subrequest"><literal>r.subrequest(<value>uri</value>[,
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
152 <value>options</value>[, <value>callback</value>]])</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
153 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
154 создаёт подзапрос с заданными <literal>uri</literal> и
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
155 <literal>options</literal> и
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
156 устанавливает необязательный <literal>callback</literal> завершения.
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
157
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
158 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
159 Если <literal>options</literal> является строкой, то в ней
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
160 содержится срока аргументов подзапроса.
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
161 В противном случае ожидается, что <literal>options</literal> является объектом
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
162 со следующими ключами:
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
163
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
164 <list type="tag">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
165 <tag-name><literal>args</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
166 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
167 строка с аргументами
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
168 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
169
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
170 <tag-name><literal>body</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
171 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
172 тело запроса
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
173 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
174
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
175 <tag-name><literal>method</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
176 <tag-desc
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
177 >метод HTTP
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
178 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
179
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
180 </list>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
181 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
182
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
183 <para>
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
184 <literal>callback</literal> получает
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
185 объект ответа подзапроса с методами и свойствами,
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
186 идентичными родительскому объекту запроса.
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
187 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
188 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
189
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
190 </list>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
191 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
192
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
193 </section>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
194
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
195 </section>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
196
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
197
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
198 <section id="stream" name="Stream">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
199
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
200 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
201 Объекты <literal>stream</literal> доступны только в
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
202 модуле
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
203 <link doc="../stream/ngx_stream_js_module.xml">ngx_stream_js_module</link>.
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
204 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
205
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
206
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
207 <section id="stream_session" name="Сессия">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
208
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
209 <para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
210 <list type="tag">
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
211
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
212 <tag-name><literal>s.remoteAddress</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
213 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
214 адрес клиента, только чтение
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
215 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
216
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
217 <tag-name><literal>s.eof</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
218 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
219 логическое свойство,
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
220 true, если текущий буфер является последним буфером,
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
221 только чтение
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
222 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
223
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
224 <tag-name><literal>s.fromUpstream</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
225 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
226 логическое свойство,
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
227 true, если текущий буфер является буфером от проксируемого сервера к клиенту,
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
228 только чтение
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
229 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
230
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
231 <tag-name><literal>s.buffer</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
232 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
233 текущий буфер, доступен для записи
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
234 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
235
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
236 <tag-name><literal>s.variables{}</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
237 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
238 объект переменных nginx, только чтение
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
239 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
240
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
241 <tag-name><literal>s.OK</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
242 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
243 код <literal>OK</literal>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
244 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
245
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
246 <tag-name><literal>s.DECLINED</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
247 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
248 код <literal>DECLINED</literal>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
249 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
250
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
251 <tag-name><literal>s.AGAIN</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
252 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
253 код <literal>AGAIN</literal>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
254 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
255
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
256 <tag-name><literal>s.ERROR</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
257 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
258 код <literal>ERROR</literal>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
259 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
260
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
261 <tag-name><literal>s.ABORT</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
262 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
263 код <literal>ABORT</literal>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
264 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
265
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
266 <tag-name><literal>s.log(<value>строка</value>)</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
267 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
268 записывает отправленную <value>строку</value> в лог-файл ошибок
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
269 на уровне лога <literal>info</literal>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
270 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
271
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
272 <tag-name><literal>s.warn(<value>строка</value>)</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
273 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
274 записывает отправленную <literal>строку</literal> в лог-файл ошибок
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
275 на уровне лога <literal>warning</literal>
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
276 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
277
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
278 <tag-name><literal>s.error(<value>строка</value>)</literal></tag-name>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
279 <tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
280 записывает отправленную <literal>строку</literal> в лог-файл ошибок
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
281 на уровне лога <literal>error</literal>
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
282 </tag-desc>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
283
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
284 </list>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
285 </para>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
286
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
287 </section>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
288
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
289 </section>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
290
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
291
2182
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
292 <section id="example" name="Примеры">
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
293
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
294
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
295 <section id="example_urldecode" name="Декодирование URL">
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
296
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
297 <para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
298 <example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
299 js_include urldecode.js;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
300
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
301 js_set $decoded_foo decoded_foo;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
302 </example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
303 </para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
304
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
305 <para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
306 Файл <path>urldecode.js</path>:
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
307 <example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
308 function decoded_foo(r) {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
309 return decodeURIComponent(r.args.foo);
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
310 }
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
311 </example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
312 </para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
313
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
314 </section>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
315
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
316
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
317 <section id="example_urlencode" name="Кодирование URL">
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
318
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
319 <para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
320 <example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
321 js_include urlencode.js;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
322
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
323 js_set $encoded_foo encoded_foo;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
324 ...
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
325
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
326 location / {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
327 proxy_pass http://example.com?foo=$encoded_foo;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
328 }
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
329 </example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
330 </para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
331
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
332 <para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
333 Файл <path>urlencode.js</path>:
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
334 <example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
335 function encoded_foo(r) {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
336 return encodeURIComponent('foo &amp; bar?');
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
337 }
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
338 </example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
339 </para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
340
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
341 </section>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
342
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
343
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
344 <section id="example_fast_response" name="Возврат самого быстрого ответа от прокси">
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
345
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
346 <para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
347 <example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
348 js_include fastresponse.js;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
349
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
350 location /start {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
351 js_content content;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
352 }
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
353
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
354 location /foo {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
355 proxy_pass http://backend1;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
356 }
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
357
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
358 location /bar {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
359 proxy_pass http://backend2;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
360 }
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
361 </example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
362 </para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
363
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
364 <para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
365 Файл <path>fastresponse.js</path>:
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
366 <example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
367 function content(r) {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
368 var n = 0;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
369
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
370 function done(res) {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
371 if (n++ == 0) {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
372 r.return(res.status, res.responseBody);
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
373 }
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
374 }
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
375
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
376 r.subrequest('/foo', r.variables.args, done);
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
377 r.subrequest('/bar', r.variables.args, done);TBD
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
378 }
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
379 </example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
380 </para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
381
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
382 </section>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
383
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
384
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
385 <section id="example_jwt" name="Создание HS JWT">
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
386
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
387 <para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
388 <example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
389 js_include hs_jwt.js;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
390
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
391 js_set $jwt jwt;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
392 </example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
393 </para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
394
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
395 <para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
396 Файл <path>hs_jwt.js</path>:
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
397 <example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
398 function create_hs256_jwt(claims, key, valid) {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
399 var header = { "typ" : "JWT", "alg" : "HS256", "exp" : Date.now() + valid };
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
400
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
401 var s = JSON.stringify(header).toBytes().toString('base64url') + '.'
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
402 + JSON.stringify(claims).toBytes().toString('base64url');
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
403
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
404 var h = require('crypto').createHmac('sha256', key);
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
405
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
406 return s + '.' + h.update(s).digest().toString('base64url');
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
407 }
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
408
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
409 function jwt(r) {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
410 var claims = {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
411 "iss" : "nginx",
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
412 "sub" : "alice",
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
413 "foo" : 123,
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
414 "bar" : "qq",
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
415 "zyx" : false
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
416 };
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
417
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
418 return create_hs256_jwt(claims, 'foo', 600);
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
419 }
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
420 </example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
421 </para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
422
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
423 </section>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
424
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
425
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
426 <section id="example_subrequest" name="Доступ к API при помощи подзапроса">
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
427
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
428 <para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
429 <example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
430 js_include subrequest.js;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
431
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
432 keyval_zone zone=foo:10m;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
433 ...
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
434
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
435 location /keyval {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
436 js_content set_keyval;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
437 }
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
438
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
439 location /version {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
440 js_content version;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
441 }
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
442
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
443 location /api {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
444 api write=on;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
445 }
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
446 </example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
447 </para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
448
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
449 <para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
450 Файл <path>subrequest.js</path>:
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
451 <example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
452 function set_keyval(r) {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
453 r.subrequest('/api/3/http/keyvals/foo',
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
454 { method: 'POST',
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
455 body: JSON.stringify({ foo: 789, bar: "ss dd 00" })},
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
456
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
457 function(res) {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
458 if (res.status >= 300) {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
459 r.return(res.status, res.responseBody);
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
460 return;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
461 }
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
462 r.return(500);
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
463 });
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
464 }
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
465 function version(r) {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
466 r.subrequest('/api/3/nginx', { method: 'GET' }, function(res) {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
467 if (res.status != 200) {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
468 r.return(res.status);
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
469 return;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
470 }
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
471
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
472 var json = JSON.parse(res.responseBody);
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
473 r.return(200, json.version);
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
474 });
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
475 }
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
476 </example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
477 </para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
478
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
479 </section>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
480
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
481
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
482 <section id="example_secure_link" name="Создание хэша secure_link">
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
483
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
484 <para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
485 <example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
486 js_include hash.js;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
487
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
488 js_set $new_foo create_secure_link;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
489 ...
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
490
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
491 location / {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
492 secure_link $cookie_foo;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
493 secure_link_md5 "$uri mykey";
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
494 ...
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
495 }
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
496
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
497 location @login {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
498 add_header Set-Cookie "foo=$new_foo; Max-Age=60";
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
499 return 302 /;
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
500 }
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
501 </example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
502 </para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
503
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
504 <para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
505 Файл <path>hash.js</path>:
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
506 <example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
507 function create_secure_link(r) {
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
508 return require('crypto').createHash('md5')
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
509 .update(r.uri).update(" mykey")
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
510 .digest('base64url');
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
511 }
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
512 </example>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
513 </para>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
514
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
515 </section>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
516
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
517 </section>
7865ca0da0ab Merged HTTP request,response, and reply in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
518
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
519 </article>
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
520