ngx_stream_js_module モジュール
設定例 ディレクティブ js_access js_filter js_import js_include js_path js_preread js_set セッションオブジェクトプロパティ |
ngx_stream_js_module
モジュールはnjs - JavaScript言語のサブセット、でのハンドラを実装するために使われます。
ダウンロードとインストールの説明はここで利用可能です。
設定例
この例は、0.4.0以降で動作します。
stream { js_import stream.js; js_set $bar stream.bar; js_set $req_line stream.req_line; server { listen 12345; js_preread stream.preread; return $req_line; } server { listen 12346; js_access stream.access; proxy_pass 127.0.0.1:8000; js_filter stream.header_inject; } } http { server { listen 8000; location / { return 200 $http_foo\n; } } }
The stream.js
file:
var line = ''; function bar(s) { var v = s.variables; s.log("hello from bar() handler!"); return "bar-var" + v.remote_port + "; pid=" + v.pid; } function preread(s) { s.on('upload', function (data, flags) { var n = data.indexOf('\n'); if (n != -1) { line = data.substr(0, n); s.done(); } }); } function req_line(s) { return line; } // Read HTTP request line. // Collect bytes in 'req' until // request line is read. // Injects HTTP header into a client's request var my_header = 'Foo: foo'; function header_inject(s) { var req = ''; s.on('upload', function(data, flags) { req += data; var n = req.search('\n'); if (n != -1) { var rest = req.substr(n + 1); req = req.substr(0, n + 1); s.send(req + my_header + '\r\n' + rest, flags); s.off('upload'); } }); } function access(s) { if (s.remoteAddress.match('^192.*')) { s.abort(); return; } s.allow(); } export default {bar, preread, req_line, access};
ディレクティブ
構文: |
js_access |
---|---|
デフォルト: | - |
コンテキスト: |
stream , server |
access フェーズで呼ばれるnjs関数を設定します。0.4.0以降、モジュール関数を参照できます。
構文: |
js_filter |
---|---|
デフォルト: | - |
コンテキスト: |
stream , server |
データフィルタを設定します。0.4.0以降、モジュール関数を参照できます。
構文: |
js_import |
---|---|
デフォルト: | - |
コンテキスト: |
stream |
このディレクティブはアb―ジョン0.4.0で導入されました。
njs内のlocationと変数を実装するモジュールをインポートします。export_name
は、モジュール関数にアクセスするための名前空間として使います。export_name
が指定されない場合、モジュール名が名前空間として使われます。
js_import stream.js;
ここで、モジュール名stream
はエクスポートにアクセスする時に名前空間として使われます。インポートされたモジュールがfoo()
を含む場合、stream.foo
はそれを参照するために使われます。
いくつかのjs_import
ディレクティブを指定できます。
構文: |
js_include |
---|---|
デフォルト: | - |
コンテキスト: |
stream |
njs内のサーバと変数のハンドラを実装するファイルを指定します:
nginx.conf: js_include stream.js; js_set $js_addr address; server { listen 127.0.0.1:12345; return $js_addr; } stream.js: function address(s) { return s.remoteAddress; }
このディレクティブは0.4.0以降非推奨で、代わりにjs_importディレクティブを使ってください。
構文: |
js_path
|
---|---|
デフォルト: | - |
コンテキスト: |
stream |
このディレクティブはバージョン0.3.0から導入されました。
njsモジュールの追加のパスをせっていします。
構文: |
js_preread |
---|---|
デフォルト: | - |
コンテキスト: |
stream , server |
preread フェーズで呼ばれるnjs関数を設定します。0.4.0以降、モジュール関数を参照できます。
構文: |
js_set
|
---|---|
デフォルト: | - |
コンテキスト: |
stream |
特定の変数のためにnjs関数を設定します。0.4.0以降、モジュール関数を参照できます。
セッション オブジェクト プロパティ
各ストリーム njs ハンドラは1つの引数、ストリーム セッションオブジェクトを受け取ります。