annotate xml/ru/docs/stream/ngx_stream_js_module.xml @ 2823:652356b39f0f

Added info about removal of the js_import directive.
author Yaroslav Zhuravlev <yar@nginx.com>
date Thu, 13 Jan 2022 12:48:02 +0000
parents a2852750c379
children a3992db1d3d4
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"
2823
652356b39f0f Added info about removal of the js_import directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2773
diff changeset
12 rev="30">
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
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
145 </directive>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
146
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
147
2773
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
148 <directive name="js_fetch_ciphers">
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
149 <syntax><value>шифры</value></syntax>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
150 <default>HIGH:!aNULL:!MD5</default>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
151 <context>http</context>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
152 <context>server</context>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
153 <context>location</context>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
154 <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
155
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
156 <para>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
157 Описывает разрешённые шифры для HTTPS-соединений
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
158 при помощи <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
159 Шифры задаются в формате, поддерживаемом библиотекой OpenSSL.
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
160 </para>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
161
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
162 <para>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
163 Полный список можно посмотреть с помощью команды
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
164 “<command>openssl ciphers</command>”.
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
165 </para>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
166
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
167 </directive>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
168
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
169
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
170 <directive name="js_fetch_protocols">
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
171 <syntax>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
172 [<literal>TLSv1</literal>]
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
173 [<literal>TLSv1.1</literal>]
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
174 [<literal>TLSv1.2</literal>]
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
175 [<literal>TLSv1.3</literal>]</syntax>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
176 <default>TLSv1 TLSv1.1 TLSv1.2</default>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
177 <context>http</context>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
178 <context>server</context>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
179 <context>location</context>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
180 <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
181
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
182 <para>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
183 Разрешает указанные протоколы для HTTPS-соединений
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
184 при помощи <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
185 </para>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
186
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
187 </directive>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
188
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
189
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
190 <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
191 <syntax><value>файл</value></syntax>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
192 <default/>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
193 <context>http</context>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
194 <context>server</context>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
195 <context>location</context>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
196 <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
197
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
198 <para>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
199 Задаёт <value>файл</value> с доверенными сертификатами CA в формате PEM,
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
200 используемыми при
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
201 <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
202 HTTPS-сертификата
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
203 при помощи <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
204 </para>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
205
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
206 </directive>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
207
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
208
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
209 <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
210 <syntax><value>число</value></syntax>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
211 <default>100</default>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
212 <context>http</context>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
213 <context>server</context>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
214 <context>location</context>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
215 <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
216
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
217 <para>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
218 Устанавливает глубину проверки в цепочке HTTPS-сертификатов
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
219 при помощи <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
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 </directive>
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
223
a2852750c379 Added fetch directives to js http and stream modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2747
diff changeset
224
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
225 <directive name="js_filter">
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
226 <syntax><value>функция</value> | <value>модуль.функция</value></syntax>
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
227 <default/>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
228 <context>stream</context>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
229 <context>server</context>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
230
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
231 <para>
1843
3492eb9b8138 Translated http and stream js modules into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1840
diff changeset
232 Задаёт фильтр данных.
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
233 Начиная с <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
234 можно ссылаться на функцию модуля.
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
235 </para>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
236
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
237 </directive>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
238
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
239
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
240 <directive name="js_import">
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
241 <syntax><value>модуль.js</value> |
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
242 <value>имя_экспорта из модуль.js</value></syntax>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
243 <default/>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
244 <context>stream</context>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
245 <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
246
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
247 <para>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
248 Импортирует модуль, позволяющий задавать обработчики location и переменных
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
249 на njs.
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
250 <literal>Имя_экспорта</literal> является пространством имён
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
251 при доступе к функциям модуля.
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
252 Если <literal>имя_экспорта</literal> не задано,
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
253 то пространством имён будет являться имя модуля.
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
254 <example>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
255 js_import stream.js;
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
256 </example>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
257 В примере при доступе к экспорту в качестве
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
258 пространства имён используется имя модуля <literal>stream</literal>.
2680
8751cab1d562 Corrected example description in js_import.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2649
diff changeset
259 Если импортируемый модуль экспортирует <literal>foo()</literal>,
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
260 то для доступа используется <literal>stream.foo</literal>.
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
261 </para>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
262
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
263 <para>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
264 Директив <literal>js_import</literal> может быть несколько.
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
265 </para>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
266
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
267 </directive>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
268
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
269
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
270 <directive name="js_include">
1843
3492eb9b8138 Translated http and stream js modules into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1840
diff changeset
271 <syntax><value>файл</value></syntax>
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
272 <default/>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
273 <context>stream</context>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
274
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
275 <para>
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
276 Задаёт файл, который позволяет задавать обработчики server и переменных на njs:
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
277 <example>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
278 nginx.conf:
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
279 js_include stream.js;
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
280 js_set $js_addr address;
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
281 server {
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
282 listen 127.0.0.1:12345;
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
283 return $js_addr;
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
284 }
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
285
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
286 stream.js:
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
287 function address(s) {
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
288 return s.remoteAddress;
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
289 }
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
290 </example>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
291 </para>
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
292
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
293 <para>
2823
652356b39f0f Added info about removal of the js_import directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2773
diff changeset
294 Директива устарела в версии
652356b39f0f Added info about removal of the js_import directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2773
diff changeset
295 <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
296 и была удалена в версии
652356b39f0f Added info about removal of the js_import directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2773
diff changeset
297 <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
298 Вместо неё следует использовать директиву <link id="js_import"/>.
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
299 </para>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
300
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
301 </directive>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
302
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
303
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
304 <directive name="js_preread">
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
305 <syntax><value>функция</value> | <value>модуль.функция</value></syntax>
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
306 <default/>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
307 <context>stream</context>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
308 <context>server</context>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
309
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
310 <para>
2128
59a3cc84f507 Renamed nginScript to njs
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2026
diff changeset
311 Задаёт функцию njs, которая будет вызываться в
1843
3492eb9b8138 Translated http and stream js modules into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1840
diff changeset
312 <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
313 Начиная с <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
314 можно ссылаться на функцию модуля.
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
315 </para>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
316
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
317 </directive>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
318
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
319
2352
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
320 <directive name="js_path">
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
321 <syntax>
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
322 <value>путь</value></syntax>
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
323 <default/>
2591
f27cedd43e0f Corrected syntax of js_path in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2534
diff changeset
324 <context>stream</context>
2352
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
325 <appeared-in>0.3.0</appeared-in>
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
326
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
327 <para>
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
328 Задаёт дополнительный путь для модулей njs.
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
329 </para>
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
330
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
331 </directive>
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
332
1101e24c6d14 Documented the js_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2332
diff changeset
333
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
334 <directive name="js_set">
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
335 <syntax>
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
336 <value>$переменная</value> <value>функция</value> |
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
337 <value>модуль.функция</value></syntax>
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
338 <default/>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
339 <context>stream</context>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
340
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
341 <para>
2686
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
342 Задаёт <literal>функцию</literal> njs
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
343 для указанной <literal>переменной</literal>.
2530
407c5bd5bffc Documented the js_import directive and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2352
diff changeset
344 Начиная с <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
345 можно ссылаться на функцию модуля.
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
346 </para>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
347
2686
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
348 <para>
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
349 Функция вызывается в момент
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
350 первого обращения к переменной для данного запроса.
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
351 Точный момент вызова функции зависит от
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
352 <link doc="stream_processing.xml">фазы</link>,
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
353 в которой происходит обращение к переменной.
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
354 Это можно использовать для реализации дополнительной логики,
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
355 не относящейся к вычислению переменной.
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
356 Например, если переменная указана
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
357 в директиве <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
358 то её обработчик не будет выполняться до фазы записи в лог.
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
359 Этот обработчик также может использоваться для выполнения процедур
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
360 непосредственно перед освобождением запроса.
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
361 </para>
45214e5316cd Improved description of js_set.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2680
diff changeset
362
2747
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
363 <para>
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
364 <note>
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
365 Так как обработчик <literal>js_set</literal>
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
366 должен сразу возвращать результат,
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
367 то поддерживаются только синхронные вызовы.
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
368 Таким образом, асинхронные вызовы, например
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
369 <link doc="../njs/reference.xml" id="ngx_fetch">ngx.fetch()</link>
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
370 или
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
371 <link doc="../njs/reference.xml" id="settimeout">setTimeout()</link>,
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
372 не поддерживаются.
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
373 </note>
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
374 </para>
42fb92e582db Added note to js_set about asyncronous calls.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2697
diff changeset
375
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
376 </directive>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
377
2693
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
378
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
379 <directive name="js_var">
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
380 <syntax><value>$переменная</value> [<value>значение</value>]</syntax>
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
381 <default/>
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
382 <context>stream</context>
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
383 <appeared-in>0.5.3</appeared-in>
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
384
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
385 <para>
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
386 Объявляет
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
387 <link doc="../njs/reference.xml" id="r_variables">перезаписываемую</link>
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
388 переменную.
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
389 В качестве значения можно использовать текст, переменные и их комбинации.
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
390 </para>
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
391
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
392 </directive>
3cbd6e440581 Documented the js_var directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2686
diff changeset
393
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
394 </section>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
395
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
396
1843
3492eb9b8138 Translated http and stream js modules into Russian.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1840
diff changeset
397 <section id="properties" name="Свойства объекта сессии">
1840
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
398
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
399 <para>
2175
cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2135
diff changeset
400 Каждый stream-обработчик njs получает один аргумент,
2288
786e96c52c7a Corrected links and example in Russian http and stream js modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2246
diff changeset
401 <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
402 </para>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
403
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
404 </section>
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
405
15632fc2d548 Documented http and stream nginScript modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
406 </module>