nginx-site: xml/en/docs/stream/ngx_stream_js

annotate xml/en/docs/stream/ngx_stream_js_module.xml @ 2901:9719a0184a67

Documented the js_preload_object directive.

author	Yaroslav Zhuravlev <yar@nginx.com>
date	Fri, 21 Oct 2022 12:19:07 +0100
parents	986e1f930e3b
children	3cc6e38246b1

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
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	9 <module name="Module ngx_stream_js_module"
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	10 link="/en/docs/stream/ngx_stream_js_module.html"
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	11 lang="en"
2901 9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	12 rev="34">
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>
1844 f56626ce9c40 Changed JavaScript to nginScript. Yaroslav Zhuravlev <yar@nginx.com> parents: 1840 diff changeset	17 The <literal>ngx_stream_js_module</literal> module is used to implement
2245 87a0e2c73a25 Refactored njs documentation. Yaroslav Zhuravlev <yar@nginx.com> parents: 2244 diff changeset	18 handlers in <link doc="../njs/index.xml">njs</link> —
1844 f56626ce9c40 Changed JavaScript to nginScript. Yaroslav Zhuravlev <yar@nginx.com> parents: 1840 diff changeset	19 a subset of the JavaScript language.
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 Download and install instructions are available
2245 87a0e2c73a25 Refactored njs documentation. Yaroslav Zhuravlev <yar@nginx.com> parents: 2244 diff changeset	24 <link doc="../njs/install.xml">here</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
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	30 <section id="example" name="Example Configuration">
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 The example works since
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>
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	70 The <path>stream.js</path> file:
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 });
5268c13196f2 Documented njs changes triggered by njs-0.2.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2190 diff changeset	88 }
5268c13196f2 Documented njs changes triggered by njs-0.2.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2190 diff changeset	89
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;
1840 15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	92 }
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 // Read HTTP request line.
5268c13196f2 Documented njs changes triggered by njs-0.2.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2190 diff changeset	95 // Collect bytes in 'req' until
5268c13196f2 Documented njs changes triggered by njs-0.2.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2190 diff changeset	96 // request line is read.
5268c13196f2 Documented njs changes triggered by njs-0.2.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2190 diff changeset	97 // Injects HTTP header into a client's request
1840 15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	98
2237 5268c13196f2 Documented njs changes triggered by njs-0.2.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2190 diff changeset	99 var my_header = 'Foo: foo';
5268c13196f2 Documented njs changes triggered by njs-0.2.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2190 diff changeset	100 function header_inject(s) {
5268c13196f2 Documented njs changes triggered by njs-0.2.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2190 diff changeset	101 var req = '';
5268c13196f2 Documented njs changes triggered by njs-0.2.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2190 diff changeset	102 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	103 req += data;
5268c13196f2 Documented njs changes triggered by njs-0.2.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2190 diff changeset	104 var n = req.search('\n');
5268c13196f2 Documented njs changes triggered by njs-0.2.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2190 diff changeset	105 if (n != -1) {
5268c13196f2 Documented njs changes triggered by njs-0.2.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2190 diff changeset	106 var rest = req.substr(n + 1);
5268c13196f2 Documented njs changes triggered by njs-0.2.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2190 diff changeset	107 req = req.substr(0, n + 1);
5268c13196f2 Documented njs changes triggered by njs-0.2.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2190 diff changeset	108 s.send(req + my_header + '\r\n' + rest, flags);
5268c13196f2 Documented njs changes triggered by njs-0.2.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2190 diff changeset	109 s.off('upload');
5268c13196f2 Documented njs changes triggered by njs-0.2.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2190 diff changeset	110 }
5268c13196f2 Documented njs changes triggered by njs-0.2.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2190 diff changeset	111 });
5268c13196f2 Documented njs changes triggered by njs-0.2.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2190 diff changeset	112 }
5268c13196f2 Documented njs changes triggered by njs-0.2.4. Yaroslav Zhuravlev <yar@nginx.com> parents: 2190 diff changeset	113
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
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	130 <section id="directives" name="Directives">
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>function</value> \| <value>module.function</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 Sets an njs function which will be called at the
1840 15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	140 <link doc="stream_processing.xml" id="access_phase">access</link> phase.
2530 407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	141 Since <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 a module function can be referenced.
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 The function is called once at the moment when the stream session reaches
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	147 the <link doc="stream_processing.xml" id="access_phase">access</link> phase
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	148 for the first time.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	149 The function is called with the following arguments:
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	150
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	151 <list type="tag">
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	152 <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	153 <tag-desc>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	154 the <link doc="../njs/reference.xml" id="stream">Stream Session</link> object
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	155 </tag-desc>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	156
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	157 </list>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	158 </para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	159
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	160 <para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	161 At this phase, it is possible to perform initialization
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	162 or register a callback with
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	163 the <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	164 method
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	165 for each incoming data chunk until one of the following methods are called:
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_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	167 <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	168 <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	169 As soon as one of these methods is called, the stream session processing
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	170 switches to the <link doc="stream_processing.xml">next phase</link>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	171 and all current
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	172 <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	173 callbacks are dropped.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	174 </para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	175
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	176 <para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	177 <note>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	178 As the <literal>js_access</literal> handler
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	179 returns its result immediately, it supports
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	180 only synchronous callbacks.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	181 Thus, asynchronous callbacks such as
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	182 <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	183 or
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	184 <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	185 are not supported.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	186 </note>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	187 </para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	188
1840 15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	189 </directive>
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	190
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	191
2845 a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	192 <directive name="js_fetch_buffer_size">
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	193 <syntax><value>size</value></syntax>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	194 <default>16k</default>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	195 <context>stream</context>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	196 <context>server</context>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	197 <appeared-in>0.7.4</appeared-in>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	198
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	199 <para>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	200 Sets the <value>size</value> of the buffer used for reading and writing
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	201 with <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: 2823 diff changeset	202 </para>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	203
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	204 </directive>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	205
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 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>ciphers</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>
a2852750c379 Added fetch directives to js http and stream modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 2747 diff changeset	210 <context>stream</context>
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 Specifies the enabled ciphers for HTTPS connections
a2852750c379 Added fetch directives to js http and stream modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 2747 diff changeset	216 with <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 The ciphers are specified in the format understood by the OpenSSL library.
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 The full list can be viewed using the
a2852750c379 Added fetch directives to js http and stream modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 2747 diff changeset	222 “<command>openssl ciphers</command>” 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: 2823 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: 2823 diff changeset	229 <syntax><value>size</value></syntax>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	230 <default>1m</default>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	231 <context>stream</context>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	232 <context>server</context>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	233 <appeared-in>0.7.4</appeared-in>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	234
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	235 <para>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	236 Sets the maximum <value>size</value> of the response received
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	237 with <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: 2823 diff changeset	238 </para>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	239
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	240 </directive>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	241
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 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>
a2852750c379 Added fetch directives to js http and stream modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 2747 diff changeset	250 <context>stream</context>
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 Enables the specified protocols for HTTPS connections
a2852750c379 Added fetch directives to js http and stream modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 2747 diff changeset	256 with <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: 2823 diff changeset	262 <directive name="js_fetch_timeout">
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	263 <syntax><value>time</value></syntax>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	264 <default>60s</default>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	265 <context>stream</context>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	266 <context>server</context>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	267 <appeared-in>0.7.4</appeared-in>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	268
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	269 <para>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	270 Defines a timeout for reading and writing
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	271 for <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: 2823 diff changeset	272 The timeout is set only between two successive read/write operations,
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	273 not for the whole response.
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	274 If no data is transmitted within this time, the connection is closed.
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	275 </para>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	276
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	277 </directive>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	278
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 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>file</value></syntax>
a2852750c379 Added fetch directives to js http and stream modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 2747 diff changeset	282 <default/>
a2852750c379 Added fetch directives to js http and stream modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 2747 diff changeset	283 <context>stream</context>
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 Specifies a <value>file</value> with trusted CA certificates in the PEM format
a2852750c379 Added fetch directives to js http and stream modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 2747 diff changeset	289 used to
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">verify</link>
a2852750c379 Added fetch directives to js http and stream modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 2747 diff changeset	291 the HTTPS certificate
a2852750c379 Added fetch directives to js http and stream modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 2747 diff changeset	292 with <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: 2823 diff changeset	298 <directive name="js_fetch_verify">
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 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: 2823 diff changeset	300 <default>on</default>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	301 <context>stream</context>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	302 <context>server</context>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	303 <appeared-in>0.7.4</appeared-in>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	304
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	305 <para>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	306 Enables or disables verification of the HTTPS server certificate
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	307 with <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: 2823 diff changeset	308 </para>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	309
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	310 </directive>
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 diff changeset	311
a3aee2697d4e Documented directives for Fetch API in njs. Yaroslav Zhuravlev <yar@nginx.com> parents: 2823 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>number</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>
a2852750c379 Added fetch directives to js http and stream modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 2747 diff changeset	316 <context>stream</context>
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 Sets the verification depth in the HTTPS server certificates chain
a2852750c379 Added fetch directives to js http and stream modules. Yaroslav Zhuravlev <yar@nginx.com> parents: 2747 diff changeset	322 with <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>function</value> \| <value>module.function</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>
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	335 Sets a data filter.
2530 407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	336 Since <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 a module function can be referenced.
2878 fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	338 The filter function is called once at the moment when the stream session reaches
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	339 the <link doc="stream_processing.xml" id="content_phase">content</link> phase.
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 The filter function is called with the following arguments:
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 the <link doc="../njs/reference.xml" id="stream">Stream Session</link> object
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 At this phase, it is possible to perform initialization
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	355 or register a callback with
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	356 the <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 method for each incoming data chunk.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	358 The
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	359 <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	360 method may be used to unregister a callback and stop filtering.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	361 </para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	362
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	363 <para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	364 <note>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	365 As the <literal>js_filter</literal> handler
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	366 returns its result immediately, it supports
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	367 only synchronous operations.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	368 Thus, asynchronous operations such as
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	369 <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	370 or
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	371 <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	372 are not supported.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	373 </note>
2530 407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	374 </para>
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	375
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	376 </directive>
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	377
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 <directive name="js_import">
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	380 <syntax><value>module.js</value> \|
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	381 <value>export_name from module.js</value></syntax>
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	382 <default/>
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	383 <context>stream</context>
2882 986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	384 <context>server</context>
2530 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 Imports a module that implements location and variable handlers in njs.
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	389 The <literal>export_name</literal> is used as a namespace
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	390 to access module functions.
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	391 If the <literal>export_name</literal> is not specified,
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	392 the module name will be used as a namespace.
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	393 <example>
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	394 js_import stream.js;
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	395 </example>
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	396 Here, the module name <literal>stream</literal> is used as a namespace
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	397 while accessing exports.
2680 8751cab1d562 Corrected example description in js_import. Yaroslav Zhuravlev <yar@nginx.com> parents: 2649 diff changeset	398 If the imported module exports <literal>foo()</literal>,
2530 407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	399 <literal>stream.foo</literal> is used to refer to it.
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	400 </para>
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	401
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	402 <para>
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	403 Several <literal>js_import</literal> directives can be specified.
1840 15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	404 </para>
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	405
2882 986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	406 <para>
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	407 <note>
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	408 The directive can be specified on the
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	409 <literal>server</literal> level
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	410 since <link doc="../njs/changes.xml" id="njs0.7.7">0.7.7</link>.
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	411 </note>
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	412 </para>
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	413
1840 15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	414 </directive>
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	415
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	416
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	417 <directive name="js_include">
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	418 <syntax><value>file</value></syntax>
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	419 <default/>
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	420 <context>stream</context>
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	421
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	422 <para>
2530 407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	423 Specifies a file that implements server and variable handlers in njs:
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	424 <example>
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	425 nginx.conf:
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	426 js_include stream.js;
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	427 js_set $js_addr address;
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	428 server {
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	429 listen 127.0.0.1:12345;
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	430 return $js_addr;
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	431 }
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 stream.js:
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	434 function address(s) {
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	435 return s.remoteAddress;
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	436 }
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	437 </example>
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	438 </para>
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	439
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	440 <para>
2823 652356b39f0f Added info about removal of the js_import directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2773 diff changeset	441 The directive was made obsolete in version
652356b39f0f Added info about removal of the js_import directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2773 diff changeset	442 <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	443 and was removed in version
652356b39f0f Added info about removal of the js_import directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2773 diff changeset	444 <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	445 The <link id="js_import"/> directive should be used instead.
1840 15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	446 </para>
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	447
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	448 </directive>
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
2352 1101e24c6d14 Documented the js_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	451 <directive name="js_path">
1101e24c6d14 Documented the js_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	452 <syntax>
1101e24c6d14 Documented the js_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	453 <value>path</value></syntax>
1101e24c6d14 Documented the js_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	454 <default/>
2591 f27cedd43e0f Corrected syntax of js_path in stream. Yaroslav Zhuravlev <yar@nginx.com> parents: 2534 diff changeset	455 <context>stream</context>
2882 986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	456 <context>server</context>
2352 1101e24c6d14 Documented the js_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	457 <appeared-in>0.3.0</appeared-in>
1101e24c6d14 Documented the js_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	458
1101e24c6d14 Documented the js_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	459 <para>
1101e24c6d14 Documented the js_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	460 Sets an additional path for njs modules.
1101e24c6d14 Documented the js_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	461 </para>
1101e24c6d14 Documented the js_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	462
2882 986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	463 <para>
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	464 <note>
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	465 The directive can be specified on the
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	466 <literal>server</literal> level
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	467 since <link doc="../njs/changes.xml" id="njs0.7.7">0.7.7</link>.
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	468 </note>
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	469 </para>
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	470
2352 1101e24c6d14 Documented the js_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	471 </directive>
1101e24c6d14 Documented the js_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	472
1101e24c6d14 Documented the js_path directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2332 diff changeset	473
2901 9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	474 <directive name="js_preload_object">
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	475 <syntax><value>name.json</value> \|
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	476 <value>name</value> from <value>file.json</value></syntax>
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	477 <default/>
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	478 <context>stream</context>
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	479 <context>server</context>
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	480 <appeared-in>0.7.8</appeared-in>
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	481
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	482 <para>
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	483 Preloads an immutable object at configure time.
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	484 The <literal>name</literal> is used a name of the global variable
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	485 though which the object is available in njs code.
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	486 If the <literal>name</literal> is not specified,
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	487 the file name will be used instead.
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	488 <example>
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	489 js_preload_object map.json;
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	490 </example>
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	491 Here, the <literal>map</literal> is used as a name
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	492 while accessing the preloaded object.
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	493 </para>
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	494
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	495 <para>
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	496 Several <literal>js_preload_object</literal> directives can be specified.
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	497 </para>
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	498
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	499 </directive>
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	500
9719a0184a67 Documented the js_preload_object directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2882 diff changeset	501
1840 15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	502 <directive name="js_preread">
2530 407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	503 <syntax><value>function</value> \| <value>module.function</value></syntax>
1840 15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	504 <default/>
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	505 <context>stream</context>
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	506 <context>server</context>
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 <para>
2128 59a3cc84f507 Renamed nginScript to njs Yaroslav Zhuravlev <yar@nginx.com> parents: 2026 diff changeset	509 Sets an njs function which will be called at the
1840 15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	510 <link doc="stream_processing.xml" id="preread_phase">preread</link> phase.
2530 407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	511 Since <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	512 a module function can be referenced.
1840 15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	513 </para>
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	514
2878 fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	515 <para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	516 The function is called once
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	517 at the moment when the stream session reaches the
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	518 <link doc="stream_processing.xml" id="preread_phase">preread</link> phase
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	519 for the first time.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	520 The function is called with the following arguments:
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	521
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	522 <list type="tag">
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	523 <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	524 <tag-desc>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	525 the <link doc="../njs/reference.xml" id="stream">Stream Session</link> object
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	526 </tag-desc>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	527
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	528 </list>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	529 </para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	530
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	531 <para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	532 At this phase, it is possible to perform initialization
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	533 or register a callback with
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	534 the <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	535 method
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	536 for each incoming data chunk until one of the following methods are called:
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	537 <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	538 <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	539 <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	540 When one of these methods is called,
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	541 the stream session switches to the
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	542 <link doc="stream_processing.xml">next phase</link>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	543 and all current
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	544 <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	545 callbacks are dropped.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	546 </para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	547
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	548 <para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	549 <note>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	550 As the <literal>js_preread</literal> handler
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	551 returns its result immediately, it supports
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	552 only synchronous callbacks.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	553 Thus, asynchronous callbacks such as
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	554 <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	555 or
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	556 <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	557 are not supported.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	558 Nevertheless, asynchronous operations are supported in
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	559 <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	560 callbacks in the
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	561 <link doc="stream_processing.xml" id="preread_phase">preread</link> phase.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	562 See
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	563 <link url="https://github.com/nginx/njs-examples#authorizing-connections-using-ngx-fetch-as-auth-request-stream-auth-request">this example</link> for more information.
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	564 </note>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	565 </para>
fd8ec06ceafa Improved descriptions of js_access, js_filter, js_preread. Yaroslav Zhuravlev <yar@nginx.com> parents: 2845 diff changeset	566
1840 15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	567 </directive>
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	568
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	569
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	570 <directive name="js_set">
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	571 <syntax>
2530 407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	572 <value>$variable</value> <value>function</value> \|
407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	573 <value>module.function</value></syntax>
1840 15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	574 <default/>
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	575 <context>stream</context>
2882 986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	576 <context>server</context>
1840 15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	577
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	578 <para>
2686 45214e5316cd Improved description of js_set. Yaroslav Zhuravlev <yar@nginx.com> parents: 2680 diff changeset	579 Sets an njs <literal>function</literal>
45214e5316cd Improved description of js_set. Yaroslav Zhuravlev <yar@nginx.com> parents: 2680 diff changeset	580 for the specified <literal>variable</literal>.
2530 407c5bd5bffc Documented the js_import directive and corresponding changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2352 diff changeset	581 Since <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	582 a module function can be referenced.
1840 15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	583 </para>
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	584
2686 45214e5316cd Improved description of js_set. Yaroslav Zhuravlev <yar@nginx.com> parents: 2680 diff changeset	585 <para>
45214e5316cd Improved description of js_set. Yaroslav Zhuravlev <yar@nginx.com> parents: 2680 diff changeset	586 The function is called when
45214e5316cd Improved description of js_set. Yaroslav Zhuravlev <yar@nginx.com> parents: 2680 diff changeset	587 the variable is referenced for the first time for a given request.
45214e5316cd Improved description of js_set. Yaroslav Zhuravlev <yar@nginx.com> parents: 2680 diff changeset	588 The exact moment depends on a
45214e5316cd Improved description of js_set. Yaroslav Zhuravlev <yar@nginx.com> parents: 2680 diff changeset	589 <link doc="stream_processing.xml">phase</link>
45214e5316cd Improved description of js_set. Yaroslav Zhuravlev <yar@nginx.com> parents: 2680 diff changeset	590 at which the variable is referenced.
45214e5316cd Improved description of js_set. Yaroslav Zhuravlev <yar@nginx.com> parents: 2680 diff changeset	591 This can be used to perform some logic
45214e5316cd Improved description of js_set. Yaroslav Zhuravlev <yar@nginx.com> parents: 2680 diff changeset	592 not related to variable evaluation.
45214e5316cd Improved description of js_set. Yaroslav Zhuravlev <yar@nginx.com> parents: 2680 diff changeset	593 For example, if the variable is referenced only in the
45214e5316cd Improved description of js_set. Yaroslav Zhuravlev <yar@nginx.com> parents: 2680 diff changeset	594 <link doc="ngx_stream_log_module.xml" id="log_format"/> directive,
45214e5316cd Improved description of js_set. Yaroslav Zhuravlev <yar@nginx.com> parents: 2680 diff changeset	595 its handler will not be executed until the log phase.
45214e5316cd Improved description of js_set. Yaroslav Zhuravlev <yar@nginx.com> parents: 2680 diff changeset	596 This handler can be used to do some cleanup
45214e5316cd Improved description of js_set. Yaroslav Zhuravlev <yar@nginx.com> parents: 2680 diff changeset	597 right before the request is freed.
45214e5316cd Improved description of js_set. Yaroslav Zhuravlev <yar@nginx.com> parents: 2680 diff changeset	598 </para>
45214e5316cd Improved description of js_set. Yaroslav Zhuravlev <yar@nginx.com> parents: 2680 diff changeset	599
2747 42fb92e582db Added note to js_set about asyncronous calls. Yaroslav Zhuravlev <yar@nginx.com> parents: 2697 diff changeset	600 <para>
42fb92e582db Added note to js_set about asyncronous calls. Yaroslav Zhuravlev <yar@nginx.com> parents: 2697 diff changeset	601 <note>
42fb92e582db Added note to js_set about asyncronous calls. Yaroslav Zhuravlev <yar@nginx.com> parents: 2697 diff changeset	602 As the <literal>js_set</literal> handler
42fb92e582db Added note to js_set about asyncronous calls. Yaroslav Zhuravlev <yar@nginx.com> parents: 2697 diff changeset	603 returns its result immediately, it supports
42fb92e582db Added note to js_set about asyncronous calls. Yaroslav Zhuravlev <yar@nginx.com> parents: 2697 diff changeset	604 only synchronous callbacks.
42fb92e582db Added note to js_set about asyncronous calls. Yaroslav Zhuravlev <yar@nginx.com> parents: 2697 diff changeset	605 Thus, asynchronous callbacks such as
42fb92e582db Added note to js_set about asyncronous calls. Yaroslav Zhuravlev <yar@nginx.com> parents: 2697 diff changeset	606 <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	607 or
42fb92e582db Added note to js_set about asyncronous calls. Yaroslav Zhuravlev <yar@nginx.com> parents: 2697 diff changeset	608 <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	609 are not supported.
42fb92e582db Added note to js_set about asyncronous calls. Yaroslav Zhuravlev <yar@nginx.com> parents: 2697 diff changeset	610 </note>
42fb92e582db Added note to js_set about asyncronous calls. Yaroslav Zhuravlev <yar@nginx.com> parents: 2697 diff changeset	611 </para>
42fb92e582db Added note to js_set about asyncronous calls. Yaroslav Zhuravlev <yar@nginx.com> parents: 2697 diff changeset	612
2882 986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	613 <para>
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	614 <note>
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	615 The directive can be specified on the
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	616 <literal>server</literal> level
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	617 since <link doc="../njs/changes.xml" id="njs0.7.7">0.7.7</link>.
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	618 </note>
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	619 </para>
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	620
1840 15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	621 </directive>
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	622
2693 3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2686 diff changeset	623
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2686 diff changeset	624 <directive name="js_var">
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2686 diff changeset	625 <syntax><value>$variable</value> [<value>value</value>]</syntax>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2686 diff changeset	626 <default/>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2686 diff changeset	627 <context>stream</context>
2882 986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	628 <context>server</context>
2693 3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2686 diff changeset	629 <appeared-in>0.5.3</appeared-in>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2686 diff changeset	630
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2686 diff changeset	631 <para>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2686 diff changeset	632 Declares
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2686 diff changeset	633 a <link doc="../njs/reference.xml" id="r_variables">writable</link>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2686 diff changeset	634 variable.
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2686 diff changeset	635 The value can contain text, variables, and their combination.
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2686 diff changeset	636 </para>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2686 diff changeset	637
2882 986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	638 <para>
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	639 <note>
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	640 The directive can be specified on the
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	641 <literal>server</literal> level
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	642 since <link doc="../njs/changes.xml" id="njs0.7.7">0.7.7</link>.
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	643 </note>
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	644 </para>
986e1f930e3b Documented server, location, if contexts for some js directives. Yaroslav Zhuravlev <yar@nginx.com> parents: 2878 diff changeset	645
2693 3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2686 diff changeset	646 </directive>
3cbd6e440581 Documented the js_var directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 2686 diff changeset	647
1840 15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	648 </section>
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	649
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	650
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	651 <section id="properties" name="Session Object Properties">
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	652
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	653 <para>
2175 cd4889fdcfa4 Moved njs HTTP and Stream API to a separate page. Yaroslav Zhuravlev <yar@nginx.com> parents: 2135 diff changeset	654 Each stream njs handler receives one argument, a stream session
2246 32ba43abf9cd Renamed njs API, njs Changes. Yaroslav Zhuravlev <yar@nginx.com> parents: 2245 diff changeset	655 <link doc="../njs/reference.xml" id="stream">object</link>.
1840 15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	656 </para>
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	657
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	658 </section>
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	659
15632fc2d548 Documented http and stream nginScript modules. Yaroslav Zhuravlev <yar@nginx.com> parents: diff changeset	660 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/stream/ngx_stream_js_module.xml @ 2901:9719a0184a67