# HG changeset patch # User Yaroslav Zhuravlev # Date 1551194560 -10800 # Node ID 9d502d4305ac940d0ea33ca15543e0da7990fdef # Parent 5eba0f7b24a9b724f3a3bce060409971d7f5f8a7 Removed obsolete properties and examples from njs. diff --git a/xml/en/docs/njs/examples.xml b/xml/en/docs/njs/examples.xml --- a/xml/en/docs/njs/examples.xml +++ b/xml/en/docs/njs/examples.xml @@ -9,7 +9,7 @@
+ rev="4">
@@ -305,134 +305,4 @@ function create_secure_link(r) {
- -
- -
- - -Starting from njs 0.2.4, -stream configuration -example -has been changed. -For njs 0.2.3 -and earlier, use this configuration example: - -load_module modules/ngx_stream_js_module.so; -... - -stream { - js_include stream.js; - - js_set $foo foo; - js_set $bar bar; - - server { - listen 12345; - - js_preread qux; - return $foo; - } - - server { - listen 12346; - - js_access xyz; - proxy_pass 127.0.0.1:8000; - js_filter baz; - } -} - -http { - server { - listen 8000; - location / { - return 200 $http_foo\n; - } - } -} - - - - -The stream.js file: - -var req = ''; -var matched = 0; -var line = ''; - -function qux(s) { - var n = s.buffer.indexOf('\n'); - if (n == -1) { - return s.AGAIN; - } - - line = s.buffer.substr(0, n); -} - -function foo(s) { - return line; -} - -function bar(s) { - var v = s.variables; - s.log("hello from bar() handler!"); - return "foo-var" + v.remote_port + "; pid=" + v.pid; -} - -// The filter processes one buffer per call. -// The buffer is available in s.buffer both for -// reading and writing. Called for both directions. - -function baz(s) { - if (s.fromUpstream || matched) { - return; - } - - // Disable certain addresses. - - if (s.remoteAddress.match('^192.*')) { - return s.ERROR; - } - - // Read HTTP request line. - // Collect bytes in 'req' until request - // line is read. Clear current buffer to - // disable output. - - req = req + s.buffer; - s.buffer = ''; - - var n = req.search('\n'); - - if (n != -1) { - // Inject a new HTTP header. - var rest = req.substr(n + 1); - req = req.substr(0, n + 1); - - var addr = s.remoteAddress; - - s.log('req:' + req); - s.log('rest:' + rest); - - // Output the result and skip further - // processing. - - s.buffer = req + 'Foo: addr_' + addr + '\r\n' + rest; - matched = 1; - } -} - -function xyz(s) { - if (s.remoteAddress.match('^192.*')) { - return s.ABORT; - } -} - - - -
- -
-
diff --git a/xml/en/docs/njs/reference.xml b/xml/en/docs/njs/reference.xml --- a/xml/en/docs/njs/reference.xml +++ b/xml/en/docs/njs/reference.xml @@ -9,7 +9,7 @@
+ rev="21">
@@ -216,14 +216,6 @@ All string properties of the object are - -Prior to njs 0.2.4, -the stream session object had some properties which are currently -removed. - - - - s.allow() @@ -351,106 +343,6 @@ on the warning level - -
- - -These properties have been removed -in njs 0.2.4 -and are not backward compatible with the existing njs code. - - - - - -s.ABORT - -the ABORT return code - -Starting from njs 0.2.4, -the s.deny() method should be used instead. - - - -s.AGAIN - -the AGAIN return code - -Starting from njs 0.2.4, -the corresponding behavior is achieved if no -s.allow(), -s.deny(), -s.decline(), -s.done() -is invoked and a callback is registered. - - - -s.buffer - -the current buffer, writable - -Starting from 0.2.4, -the s.send() method should be used for writing. -For reading, the current buffer is available as the first argument of the -event callback. - - - -s.DECLINED - -the DECLINED return code - -Starting from njs 0.2.4, -the s.decline() method should be used instead. - - - -s.eof - -a boolean read-only property, true if the current buffer is the last buffer - -Starting from 0.2.4, -the flags.last property -should be used instead. - - - -s.ERROR - -the ERROR return code - -Starting from njs 0.2.4, -an appropriate exception can be thrown to report an error. - - - -s.fromUpstream - -a boolean read-only property, -true if the current buffer is from the upstream server to the client - -Starting from 0.2.4, -a corresponding event -(upload or download) -should be used to handle data to or from client. - - - -s.OK - -the OK return code - -Starting from njs 0.2.4, -the s.allow() method should be used instead. - - - - - - -
-
diff --git a/xml/en/docs/stream/ngx_stream_js_module.xml b/xml/en/docs/stream/ngx_stream_js_module.xml --- a/xml/en/docs/stream/ngx_stream_js_module.xml +++ b/xml/en/docs/stream/ngx_stream_js_module.xml @@ -31,14 +31,6 @@ Download and install instructions are av
- -This example is valid for -njs 0.2.4 -and later. -For njs 0.2.3 -and earlier, use -this example. - load_module modules/ngx_stream_js_module.so; ... diff --git a/xml/ru/docs/njs/examples.xml b/xml/ru/docs/njs/examples.xml --- a/xml/ru/docs/njs/examples.xml +++ b/xml/ru/docs/njs/examples.xml @@ -9,7 +9,7 @@
+ rev="4">
@@ -305,134 +305,4 @@ function create_secure_link(r) {
- -
- -
- - -Начиная с версии njs 0.2.4 -пример -конфигурации в stream -был изменён. -Для njs 0.2.3 -и более ранних версий необходимо использовать следующий пример конфигурации: - -load_module modules/ngx_stream_js_module.so; -... - -stream { - js_include stream.js; - - js_set $foo foo; - js_set $bar bar; - - server { - listen 12345; - - js_preread qux; - return $foo; - } - - server { - listen 12346; - - js_access xyz; - proxy_pass 127.0.0.1:8000; - js_filter baz; - } -} - -http { - server { - listen 8000; - location / { - return 200 $http_foo\n; - } - } -} - - - - -Файл stream.js: - -var req = ''; -var matched = 0; -var line = ''; - -function qux(s) { - var n = s.buffer.indexOf('\n'); - if (n == -1) { - return s.AGAIN; - } - - line = s.buffer.substr(0, n); -} - -function foo(s) { - return line; -} - -function bar(s) { - var v = s.variables; - s.log("hello from bar() handler!"); - return "foo-var" + v.remote_port + "; pid=" + v.pid; -} - -// Фильтр обрабатывает один буфер за вызов. -// Буфер недоступен в s.buffer для -// чтения и записи. Вызывается в обоих направлениях. - -function baz(s) { - if (s.fromUpstream || matched) { - return; - } - - // Отключение определённых адресов. - - if (s.remoteAddress.match('^192.*')) { - return s.ERROR; - } - - // Чтение строки HTTP-запроса. - // Получение байт в 'req' до того как - // будет прочитана строка запроса. Очистка текущего буфера - // для отключения вывода. - - req = req + s.buffer; - s.buffer = ''; - - var n = req.search('\n'); - - if (n != -1) { - // Inject a new HTTP header. - var rest = req.substr(n + 1); - req = req.substr(0, n + 1); - - var addr = s.remoteAddress; - - s.log('req:' + req); - s.log('rest:' + rest); - - // Вывод результата и пропуск дальнейшей - // обработки. - - s.buffer = req + 'Foo: addr_' + addr + '\r\n' + rest; - matched = 1; - } -} - -function xyz(s) { - if (s.remoteAddress.match('^192.*')) { - return s.ABORT; - } -} - - - -
- -
-
diff --git a/xml/ru/docs/njs/reference.xml b/xml/ru/docs/njs/reference.xml --- a/xml/ru/docs/njs/reference.xml +++ b/xml/ru/docs/njs/reference.xml @@ -357,108 +357,6 @@ true, если буфер должен иметь флаг flush
-
- - -Данные свойства были удалены -в njs версии 0.2.4 -и не имеют обратной совместимости с существующим кодом njs. - - - - - -s.ABORT - -код ABORT - -Начиная с версии njs 0.2.4 -необходимо использовать метод s.deny(). - - - -s.AGAIN - -код AGAIN - -Начиная с версии njs 0.2.4 -соответствующее поведение достигается, если не вызываются -s.allow(), -s.deny(), -s.decline(), -s.done() -и callback зарегистрирован. - - - -s.buffer - -текущий буфер, доступен для записи - -Начиная с версии njs 0.2.4 -для записи необходимо использовать метод s.send(). -Для чтения текущий буфер доступен в качестве первого аргумента -callback'а event. - - - -s.DECLINED - -код DECLINED - -Начиная с версии njs 0.2.4 -необходимо использовать метод s.decline(). - - - -s.eof - -логическое свойство, -true, если текущий буфер является последним буфером, -только чтение - -Начиная с версии njs 0.2.4 -необходимо использовать свойство flags.last. - - - -s.ERROR - -код ERROR - -Начиная с версии njs 0.2.4 -для сообщения об ошибке используется соответствующее исключение. - - - -s.fromUpstream - -логическое свойство, -true, если текущий буфер является буфером от проксируемого сервера к клиенту, -только чтение - -Начиная с версии njs 0.2.4 -необходимо использовать -соответствующее событие -(upload или download) -для обработки данных к клиенту или от клиента. - - - -s.OK - -код OK - -Начиная с версии njs 0.2.4 -необходимо использовать метод s.allow(). - - - - - - -
-
diff --git a/xml/ru/docs/stream/ngx_stream_js_module.xml b/xml/ru/docs/stream/ngx_stream_js_module.xml --- a/xml/ru/docs/stream/ngx_stream_js_module.xml +++ b/xml/ru/docs/stream/ngx_stream_js_module.xml @@ -31,14 +31,6 @@
- -Данный пример необходимо использовать с -версией njs 0.2.4 -и более поздними. -Для версий njs 0.2.3 -и ранее необходимо использовать -этот пример. - load_module modules/ngx_stream_js_module.so; ...