annotate xml/ru/docs/stream/ngx_stream_js_module.xml @ 2878:fd8ec06ceafa

Improved descriptions of js_access, js_filter, js_preread.
author Yaroslav Zhuravlev <yar@nginx.com>
date Mon, 08 Aug 2022 16:29:42 +0100
parents a3aee2697d4e
children 986e1f930e3b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
2
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
3 <!--
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
4 Copyright (C) Nginx, Inc.
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
5 -->
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
6
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
8
1843
3492eb9b8138 Translated http and stream js modules into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1840
diff changeset
9 <module name="Модуль ngx_stream_js_module"
3492eb9b8138 Translated http and stream js modules into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1840
diff changeset
10 link="/ru/docs/stream/ngx_stream_js_module.html"
3492eb9b8138 Translated http and stream js modules into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1840
diff changeset
11 lang="ru"
2878
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
12 rev="32">
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
13
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
14 <section id="summary">
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
15
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
16 <para>
1843
3492eb9b8138 Translated http and stream js modules into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1840
diff changeset
17 Модуль <literal>ngx_stream_js_module</literal> позволяет задавать
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
18 обработчики на <link doc="../njs/index.xml">njs</link> —
1844
f56626ce9c40 Changed JavaScript to nginScript.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1843
diff changeset
19 подмножестве языка JavaScript.
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
20 </para>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
21
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
22 <para>
2188
523dc4cc8745 Updated installation procedure in njs modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2175
diff changeset
23 Инструкция по сборке и установке доступны
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2244
diff changeset
24 <link doc="../njs/install.xml">здесь</link>.
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
25 </para>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
26
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
27 </section>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
28
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
29
1843
3492eb9b8138 Translated http and stream js modules into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1840
diff changeset
30 <section id="example" name="Пример конфигурации">
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
31
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
32 <para>
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
33 Пример работает начиная с версии
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
34 <link doc="../njs/changes.xml" id="njs0.4.0">0.4.0</link>.
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
35 <example>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
36 stream {
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
37 js_import stream.js;
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
38
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
39 js_set $bar stream.bar;
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
40 js_set $req_line stream.req_line;
1858
36cbfff92c6d Restricted context of js_set directive to http and stream only.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1853
diff changeset
41
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
42 server {
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
43 listen 12345;
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
44
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
45 js_preread stream.preread;
2237
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
46 return $req_line;
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
47 }
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
48
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
49 server {
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
50 listen 12346;
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
51
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
52 js_access stream.access;
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
53 proxy_pass 127.0.0.1:8000;
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
54 js_filter stream.header_inject;
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
55 }
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
56 }
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
57
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
58 http {
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
59 server {
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
60 listen 8000;
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
61 location / {
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
62 return 200 $http_foo\n;
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
63 }
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
64 }
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
65 }
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
66 </example>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
67 </para>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
68
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
69 <para>
1843
3492eb9b8138 Translated http and stream js modules into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1840
diff changeset
70 Файл <path>stream.js</path>:
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
71 <example>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
72 var line = '';
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
73
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
74 function bar(s) {
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
75 var v = s.variables;
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
76 s.log("hello from bar() handler!");
2237
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
77 return "bar-var" + v.remote_port + "; pid=" + v.pid;
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
78 }
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
79
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
80 function preread(s) {
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
81 s.on('upload', function (data, flags) {
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
82 var n = data.indexOf('\n');
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
83 if (n != -1) {
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
84 line = data.substr(0, n);
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
85 s.done();
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
86 }
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
87 });
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
88 }
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
89
2237
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
90 function req_line(s) {
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
91 return line;
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
92 }
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
93
2237
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
94 // Чтение строки HTTP-запроса.
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
95 // Получение байт в 'req' до того как
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
96 // будет прочитана строка запроса.
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
97 // Добавление HTTP-заголовка в запрос клиента
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
98
2288
786e96c52c7a Corrected links and example in Russian http and stream js modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2246
diff changeset
99 var my_header = 'Foo: foo';
786e96c52c7a Corrected links and example in Russian http and stream js modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2246
diff changeset
100 function header_inject(s) {
786e96c52c7a Corrected links and example in Russian http and stream js modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2246
diff changeset
101 var req = '';
786e96c52c7a Corrected links and example in Russian http and stream js modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2246
diff changeset
102 s.on('upload', function(data, flags) {
786e96c52c7a Corrected links and example in Russian http and stream js modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2246
diff changeset
103 req += data;
786e96c52c7a Corrected links and example in Russian http and stream js modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2246
diff changeset
104 var n = req.search('\n');
786e96c52c7a Corrected links and example in Russian http and stream js modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2246
diff changeset
105 if (n != -1) {
786e96c52c7a Corrected links and example in Russian http and stream js modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2246
diff changeset
106 var rest = req.substr(n + 1);
786e96c52c7a Corrected links and example in Russian http and stream js modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2246
diff changeset
107 req = req.substr(0, n + 1);
786e96c52c7a Corrected links and example in Russian http and stream js modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2246
diff changeset
108 s.send(req + my_header + '\r\n' + rest, flags);
786e96c52c7a Corrected links and example in Russian http and stream js modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2246
diff changeset
109 s.off('upload');
786e96c52c7a Corrected links and example in Russian http and stream js modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2246
diff changeset
110 }
786e96c52c7a Corrected links and example in Russian http and stream js modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2246
diff changeset
111 });
786e96c52c7a Corrected links and example in Russian http and stream js modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2246
diff changeset
112 }
786e96c52c7a Corrected links and example in Russian http and stream js modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2246
diff changeset
113
2237
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
114 function access(s) {
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
115 if (s.remoteAddress.match('^192.*')) {
2649
7517de030c0a Corrected njs example in ngx_stream_js_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2641
diff changeset
116 s.deny();
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
117 return;
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
118 }
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
119
2237
5268c13196f2 Documented njs changes triggered by njs-0.2.4.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2190
diff changeset
120 s.allow();
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
121 }
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
122
2641
ea9f4dc0c801 Fixed example in stream js module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2591
diff changeset
123 export default {bar, preread, req_line, header_inject, access};
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
124 </example>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
125 </para>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
126
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
127 </section>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
128
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
129
1843
3492eb9b8138 Translated http and stream js modules into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1840
diff changeset
130 <section id="directives" name="Директивы">
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
131
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
132 <directive name="js_access">
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
133 <syntax><value>функция</value> | <value>модуль.функция</value></syntax>
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
134 <default/>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
135 <context>stream</context>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
136 <context>server</context>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
137
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
138 <para>
2128
59a3cc84f507 Renamed nginScript to njs
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2026
diff changeset
139 Задаёт функцию njs, которая будет вызываться в
1843
3492eb9b8138 Translated http and stream js modules into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1840
diff changeset
140 <link doc="stream_processing.xml" id="access_phase">access</link>-фазе.
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
141 Начиная с <link doc="../njs/changes.xml" id="njs0.4.0">0.4.0</link>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
142 можно ссылаться на функцию модуля.
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
143 </para>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
144
2878
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
145 <para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
146 Функция вызывается однократно при первом достижении сессией
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
147 <link doc="stream_processing.xml" id="access_phase">access</link>-фазы.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
148 Функция вызывается со следующими аргументами:
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
149
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
150 <list type="tag">
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
151 <tag-name><literal>s</literal></tag-name>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
152 <tag-desc>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
153 объект <link doc="../njs/reference.xml" id="stream">stream-сессии</link>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
154 </tag-desc>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
155
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
156 </list>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
157 </para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
158
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
159 <para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
160 В этой фазе может происходить инициализация,
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
161 также при помощи метода
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
162 <link doc="../njs/reference.xml" id="s_on"><literal>s.on()</literal></link>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
163 может регистрироваться вызов
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
164 для каждого входящего блока данных пока не будет вызван один из методов:
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
165 <link doc="../njs/reference.xml" id="s_done"><literal>s.done()</literal></link>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
166 <link doc="../njs/reference.xml" id="s_decline"><literal>s.decline()</literal></link>,
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
167 <link doc="../njs/reference.xml" id="s_allow"><literal>s.allow()</literal></link>.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
168 При вызове любого из этих методов обработка сессии
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
169 переходит на <link doc="stream_processing.xml">следующую фазу</link>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
170 и все текущие вызовы
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
171 <link doc="../njs/reference.xml" id="s_on"><literal>s.on()</literal></link>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
172 сбрасываются.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
173 </para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
174
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
175 <para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
176 <note>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
177 Так как обработчик <literal>js_access</literal>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
178 должен сразу возвращать результат,
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
179 то поддерживаются только синхронные операции.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
180 Таким образом, асинхронные операции, например
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
181 <link doc="../njs/reference.xml" id="ngx_fetch"><literal>ngx.fetch()</literal></link>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
182 или
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
183 <link doc="../njs/reference.xml" id="settimeout"><literal>setTimeout()</literal></link>,
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
184 не поддерживаются.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
185 </note>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
186 </para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
187
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
188 </directive>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
189
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
190
2845
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
191 <directive name="js_fetch_buffer_size">
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
192 <syntax><value>размер</value></syntax>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
193 <default>16k</default>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
194 <context>stream</context>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
195 <context>server</context>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
196 <appeared-in>0.7.4</appeared-in>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
197
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
198 <para>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
199 Задаёт <value>размер</value> буфера, который будет использоваться
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
200 для чтения и записи для
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
201 <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
202 </para>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
203
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
204 </directive>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
205
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
206
2773
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
207 <directive name="js_fetch_ciphers">
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
208 <syntax><value>шифры</value></syntax>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
209 <default>HIGH:!aNULL:!MD5</default>
2844
eb11724745e3 Corrected syntax in some directives of the ngx_stream_js_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2832
diff changeset
210 <context>stream</context>
2773
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
211 <context>server</context>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
212 <appeared-in>0.7.0</appeared-in>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
213
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
214 <para>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
215 Описывает разрешённые шифры для HTTPS-соединений
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
216 при помощи <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
217 Шифры задаются в формате, поддерживаемом библиотекой OpenSSL.
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
218 </para>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
219
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
220 <para>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
221 Полный список можно посмотреть с помощью команды
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
222 “<command>openssl ciphers</command>”.
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
223 </para>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
224
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
225 </directive>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
226
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
227
2845
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
228 <directive name="js_fetch_max_response_buffer_size">
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
229 <syntax><value>размер</value></syntax>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
230 <default>1m</default>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
231 <context>stream</context>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
232 <context>server</context>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
233 <appeared-in>0.7.4</appeared-in>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
234
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
235 <para>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
236 Задаёт максимальный <value>размер</value> ответа, полученного
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
237 при помощи <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
238 </para>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
239
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
240 </directive>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
241
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
242
2773
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
243 <directive name="js_fetch_protocols">
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
244 <syntax>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
245 [<literal>TLSv1</literal>]
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
246 [<literal>TLSv1.1</literal>]
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
247 [<literal>TLSv1.2</literal>]
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
248 [<literal>TLSv1.3</literal>]</syntax>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
249 <default>TLSv1 TLSv1.1 TLSv1.2</default>
2844
eb11724745e3 Corrected syntax in some directives of the ngx_stream_js_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2832
diff changeset
250 <context>stream</context>
2773
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
251 <context>server</context>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
252 <appeared-in>0.7.0</appeared-in>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
253
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
254 <para>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
255 Разрешает указанные протоколы для HTTPS-соединений
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
256 при помощи <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
257 </para>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
258
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
259 </directive>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
260
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
261
2845
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
262 <directive name="js_fetch_timeout">
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
263 <syntax><value>время</value></syntax>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
264 <default>60s</default>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
265 <context>stream</context>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
266 <context>server</context>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
267 <appeared-in>0.7.4</appeared-in>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
268
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
269 <para>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
270 Задаёт таймаут при чтении и записи
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
271 при помощи <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
272 Таймаут устанавливается не на всю передачу ответа,
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
273 а только между двумя операциями чтения.
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
274 Если по истечении этого времени данные не передавались, соединение закрывается.
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
275 </para>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
276
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
277 </directive>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
278
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
279
2773
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
280 <directive name="js_fetch_trusted_certificate">
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
281 <syntax><value>файл</value></syntax>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
282 <default/>
2844
eb11724745e3 Corrected syntax in some directives of the ngx_stream_js_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2832
diff changeset
283 <context>stream</context>
2773
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
284 <context>server</context>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
285 <appeared-in>0.7.0</appeared-in>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
286
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
287 <para>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
288 Задаёт <value>файл</value> с доверенными сертификатами CA в формате PEM,
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
289 используемыми при
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
290 <link doc="../njs/reference.xml" id="fetch_verify">проверке</link>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
291 HTTPS-сертификата
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
292 при помощи <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
293 </para>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
294
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
295 </directive>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
296
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
297
2845
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
298 <directive name="js_fetch_verify">
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
299 <syntax><literal>on</literal> | <literal>off</literal></syntax>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
300 <default>on</default>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
301 <context>stream</context>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
302 <context>server</context>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
303 <appeared-in>0.7.4</appeared-in>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
304
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
305 <para>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
306 Разрешает или запрещает проверку сертификата HTTPS-сервера
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
307 при помощи <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
308 </para>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
309
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
310 </directive>
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
311
a3aee2697d4e Documented directives for Fetch API in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2844
diff changeset
312
2773
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
313 <directive name="js_fetch_verify_depth">
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
314 <syntax><value>число</value></syntax>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
315 <default>100</default>
2844
eb11724745e3 Corrected syntax in some directives of the ngx_stream_js_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2832
diff changeset
316 <context>stream</context>
2773
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
317 <context>server</context>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
318 <appeared-in>0.7.0</appeared-in>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
319
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
320 <para>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
321 Устанавливает глубину проверки в цепочке HTTPS-сертификатов
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
322 при помощи <link doc="../njs/reference.xml" id="ngx_fetch">Fetch API</link>.
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
323 </para>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
324
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
325 </directive>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
326
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
327
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
328 <directive name="js_filter">
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
329 <syntax><value>функция</value> | <value>модуль.функция</value></syntax>
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
330 <default/>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
331 <context>stream</context>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
332 <context>server</context>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
333
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
334 <para>
1843
3492eb9b8138 Translated http and stream js modules into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1840
diff changeset
335 Задаёт фильтр данных.
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
336 Начиная с <link doc="../njs/changes.xml" id="njs0.4.0">0.4.0</link>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
337 можно ссылаться на функцию модуля.
2878
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
338 Функция фильтра вызывается однократно при первом достижении сессией
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
339 <link doc="stream_processing.xml" id="content_phase">content</link>-фазы.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
340 </para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
341
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
342 <para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
343 Функция фильтра вызывается со следующими аргументами:
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
344 <list type="tag">
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
345 <tag-name><literal>s</literal></tag-name>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
346 <tag-desc>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
347 объект <link doc="../njs/reference.xml" id="stream">stream-сессии</link>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
348 </tag-desc>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
349
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
350 </list>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
351 </para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
352
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
353 <para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
354 В этой фазе может происходить инициализация,
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
355 также при помощи метода
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
356 <link doc="../njs/reference.xml" id="s_on"><literal>s.on()</literal></link>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
357 может регистрироваться вызов
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
358 для каждого входящего блока данных.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
359 Для отмены регистрации вызова и отмены фильтра
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
360 можно использовать метод
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
361 <link doc="../njs/reference.xml" id="s_off"><literal>s.off()</literal></link>.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
362 </para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
363
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
364 <para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
365 <note>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
366 Так как обработчик <literal>js_filter</literal>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
367 должен сразу возвращать результат,
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
368 то поддерживаются только синхронные операции.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
369 Таким образом, асинхронные операции, например
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
370 <link doc="../njs/reference.xml" id="ngx_fetch"><literal>ngx.fetch()</literal></link>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
371 или
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
372 <link doc="../njs/reference.xml" id="settimeout"><literal>setTimeout()</literal></link>,
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
373 не поддерживаются.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
374 </note>
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
375 </para>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
376
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
377 </directive>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
378
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
379
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
380 <directive name="js_import">
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
381 <syntax><value>модуль.js</value> |
2832
a3992db1d3d4 Corrected syntax of js_import in the Russian translation.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2823
diff changeset
382 <value>имя_экспорта from модуль.js</value></syntax>
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
383 <default/>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
384 <context>stream</context>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
385 <appeared-in>0.4.0</appeared-in>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
386
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
387 <para>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
388 Импортирует модуль, позволяющий задавать обработчики location и переменных
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
389 на njs.
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
390 <literal>Имя_экспорта</literal> является пространством имён
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
391 при доступе к функциям модуля.
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
392 Если <literal>имя_экспорта</literal> не задано,
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
393 то пространством имён будет являться имя модуля.
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
394 <example>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
395 js_import stream.js;
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
396 </example>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
397 В примере при доступе к экспорту в качестве
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
398 пространства имён используется имя модуля <literal>stream</literal>.
2680
8751cab1d562 Corrected example description in js_import.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2649
diff changeset
399 Если импортируемый модуль экспортирует <literal>foo()</literal>,
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
400 то для доступа используется <literal>stream.foo</literal>.
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
401 </para>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
402
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
403 <para>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
404 Директив <literal>js_import</literal> может быть несколько.
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
405 </para>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
406
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
407 </directive>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
408
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
409
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
410 <directive name="js_include">
1843
3492eb9b8138 Translated http and stream js modules into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1840
diff changeset
411 <syntax><value>файл</value></syntax>
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
412 <default/>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
413 <context>stream</context>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
414
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
415 <para>
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
416 Задаёт файл, который позволяет задавать обработчики server и переменных на njs:
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
417 <example>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
418 nginx.conf:
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
419 js_include stream.js;
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
420 js_set $js_addr address;
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
421 server {
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
422 listen 127.0.0.1:12345;
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
423 return $js_addr;
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
424 }
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
425
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
426 stream.js:
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
427 function address(s) {
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
428 return s.remoteAddress;
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
429 }
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
430 </example>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
431 </para>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
432
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
433 <para>
2823
652356b39f0f Added info about removal of the js_import directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2773
diff changeset
434 Директива устарела в версии
652356b39f0f Added info about removal of the js_import directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2773
diff changeset
435 <link doc="../njs/changes.xml" id="njs0.4.0">0.4.0</link>
652356b39f0f Added info about removal of the js_import directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2773
diff changeset
436 и была удалена в версии
652356b39f0f Added info about removal of the js_import directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2773
diff changeset
437 <link doc="../njs/changes.xml" id="njs0.7.1">0.7.1</link>.
652356b39f0f Added info about removal of the js_import directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2773
diff changeset
438 Вместо неё следует использовать директиву <link id="js_import"/>.
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
439 </para>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
440
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
441 </directive>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
442
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
443
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
444 <directive name="js_preread">
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
445 <syntax><value>функция</value> | <value>модуль.функция</value></syntax>
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
446 <default/>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
447 <context>stream</context>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
448 <context>server</context>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
449
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
450 <para>
2128
59a3cc84f507 Renamed nginScript to njs
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2026
diff changeset
451 Задаёт функцию njs, которая будет вызываться в
1843
3492eb9b8138 Translated http and stream js modules into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1840
diff changeset
452 <link doc="stream_processing.xml" id="preread_phase">preread</link>-фазе.
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
453 Начиная с <link doc="../njs/changes.xml" id="njs0.4.0">0.4.0</link>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
454 можно ссылаться на функцию модуля.
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
455 </para>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
456
2878
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
457 <para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
458 Функция вызывается однократно при первом достижении сессией
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
459 <link doc="stream_processing.xml" id="preread_phase">preread</link>-фазы.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
460 Функция вызывается со следующими аргументами:
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
461
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
462 <list type="tag">
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
463 <tag-name><literal>s</literal></tag-name>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
464 <tag-desc>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
465 объект <link doc="../njs/reference.xml" id="stream">stream-сессии</link>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
466 </tag-desc>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
467
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
468 </list>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
469 </para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
470
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
471 <para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
472 В этой фазе может происходить инициализация,
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
473 также при помощи метода
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
474 <link doc="../njs/reference.xml" id="s_on"><literal>s.on()</literal></link>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
475 может регистрироваться вызов
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
476 для каждого входящего блока данных пока не будет вызван один из методов:
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
477 <link doc="../njs/reference.xml" id="s_done"><literal>s.done()</literal></link>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
478 <link doc="../njs/reference.xml" id="s_decline"><literal>s.decline()</literal></link>,
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
479 <link doc="../njs/reference.xml" id="s_allow"><literal>s.allow()</literal></link>.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
480 При вызове любого из этих методов обработка сессии
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
481 переходит на <link doc="stream_processing.xml">следующую фазу</link>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
482 и все текущие вызовы
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
483 <link doc="../njs/reference.xml" id="s_on"><literal>s.on()</literal></link>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
484 сбрасываются.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
485 </para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
486
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
487 <para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
488 <note>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
489 Так как обработчик <literal>js_preread</literal>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
490 должен сразу возвращать результат,
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
491 то поддерживаются только синхронные операции.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
492 Таким образом, асинхронные операции, например
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
493 <link doc="../njs/reference.xml" id="ngx_fetch"><literal>ngx.fetch()</literal></link>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
494 или
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
495 <link doc="../njs/reference.xml" id="settimeout"><literal>setTimeout()</literal></link>,
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
496 не поддерживаются.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
497 Тем не менее асинхронные операции поддерживаются в вызовах
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
498 <link doc="../njs/reference.xml" id="s_on"><literal>s.on()</literal></link>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
499 в
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
500 <link doc="stream_processing.xml" id="preread_phase">preread</link>-фазе.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
501 Подробнее см.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
502 <link url="https://github.com/nginx/njs-examples#authorizing-connections-using-ngx-fetch-as-auth-request-stream-auth-request">пример</link>.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
503 </note>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
504 </para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
505
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
506 </directive>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
507
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
508
2352
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
509 <directive name="js_path">
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
510 <syntax>
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
511 <value>путь</value></syntax>
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
512 <default/>
2591
f27cedd43e0f Corrected syntax of js_path in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2534
diff changeset
513 <context>stream</context>
2352
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
514 <appeared-in>0.3.0</appeared-in>
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
515
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
516 <para>
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
517 Задаёт дополнительный путь для модулей njs.
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
518 </para>
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
519
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
520 </directive>
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
521
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
522
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
523 <directive name="js_set">
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
524 <syntax>
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
525 <value>$переменная</value> <value>функция</value> |
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
526 <value>модуль.функция</value></syntax>
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
527 <default/>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
528 <context>stream</context>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
529
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
530 <para>
2686
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
531 Задаёт <literal>функцию</literal> njs
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
532 для указанной <literal>переменной</literal>.
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
533 Начиная с <link doc="../njs/changes.xml" id="njs0.4.0">0.4.0</link>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
534 можно ссылаться на функцию модуля.
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
535 </para>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
536
2686
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
537 <para>
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
538 Функция вызывается в момент
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
539 первого обращения к переменной для данного запроса.
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
540 Точный момент вызова функции зависит от
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
541 <link doc="stream_processing.xml">фазы</link>,
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
542 в которой происходит обращение к переменной.
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
543 Это можно использовать для реализации дополнительной логики,
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
544 не относящейся к вычислению переменной.
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
545 Например, если переменная указана
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
546 в директиве <link doc="ngx_stream_log_module.xml" id="log_format"/>,
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
547 то её обработчик не будет выполняться до фазы записи в лог.
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
548 Этот обработчик также может использоваться для выполнения процедур
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
549 непосредственно перед освобождением запроса.
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
550 </para>
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
551
2747
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
552 <para>
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
553 <note>
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
554 Так как обработчик <literal>js_set</literal>
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
555 должен сразу возвращать результат,
2878
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
556 то поддерживаются только синхронные операции.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
557 Таким образом, асинхронные операции, например
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
558 <link doc="../njs/reference.xml" id="ngx_fetch"><literal>ngx.fetch()</literal></link>
2747
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
559 или
2878
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2845
diff changeset
560 <link doc="../njs/reference.xml" id="settimeout"><literal>setTimeout()</literal></link>,
2747
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
561 не поддерживаются.
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
562 </note>
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
563 </para>
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
564
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
565 </directive>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
566
2693
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
567
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
568 <directive name="js_var">
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
569 <syntax><value>$переменная</value> [<value>значение</value>]</syntax>
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
570 <default/>
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
571 <context>stream</context>
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
572 <appeared-in>0.5.3</appeared-in>
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
573
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
574 <para>
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
575 Объявляет
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
576 <link doc="../njs/reference.xml" id="r_variables">перезаписываемую</link>
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
577 переменную.
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
578 В качестве значения можно использовать текст, переменные и их комбинации.
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
579 </para>
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
580
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
581 </directive>
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
582
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
583 </section>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
584
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
585
1843
3492eb9b8138 Translated http and stream js modules into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1840
diff changeset
586 <section id="properties" name="Свойства объекта сессии">
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
587
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
588 <para>
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2135
diff changeset
589 Каждый stream-обработчик njs получает один аргумент,
2288
786e96c52c7a Corrected links and example in Russian http and stream js modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2246
diff changeset
590 <link doc="../njs/reference.xml" id="stream">объект</link> stream-сессии.
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
591 </para>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
592
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
593 </section>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
594
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
595 </module>