Mercurial > hg > nginx-site

changeset 2332:9d502d4305ac

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Removed obsolete properties and examples from njs.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 26 Feb 2019 18:22:40 +0300
parents 5eba0f7b24a9
children fb5e1d2d4c75
files xml/en/docs/njs/examples.xml xml/en/docs/njs/reference.xml xml/en/docs/stream/ngx_stream_js_module.xml xml/ru/docs/njs/examples.xml xml/ru/docs/njs/reference.xml xml/ru/docs/stream/ngx_stream_js_module.xml
diffstat 6 files changed, 3 insertions(+), 489 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/njs/examples.xml
+++ b/xml/en/docs/njs/examples.xml
@@ -9,7 +9,7 @@
 <article name="Examples"
         link="/en/docs/njs/examples.html"
         lang="en"
-        rev="3">
+        rev="4">
 
 <section id="helloword" name="Hello World">
 
@@ -305,134 +305,4 @@ function create_secure_link(r) {
 
 </section>
 
-
-<section id="legacy" name="Legacy Examples">
-
-<section id="legacy_stream" name="Injecting HTTP header using stream proxy">
-
-<para>
-Starting from njs <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>,
-stream configuration
-<link doc="../stream/ngx_stream_js_module.xml" id="example">example</link>
-has been changed.
-For njs <link doc="../njs/changes.xml" id="njs0.2.3">0.2.3</link>
-and earlier, use this configuration example:
-<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;
-        }
-    }
-}
-</example>
-</para>
-
-<para>
-The <path>stream.js</path> file:
-<example>
-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;
-    }
-}
-</example>
-</para>
-
-</section>
-
-</section>
-
 </article>
--- a/xml/en/docs/njs/reference.xml
+++ b/xml/en/docs/njs/reference.xml
@@ -9,7 +9,7 @@
 <article name="Reference"
         link="/en/docs/njs/reference.html"
         lang="en"
-        rev="20">
+        rev="21">
 
 <section id="summary">
 
@@ -216,14 +216,6 @@ All string properties of the object are 
 </para>
 
 <para>
-<note>
-Prior to njs <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>,
-the stream session object had some properties which are currently
-<link id="stream_obsolete">removed</link>.
-</note>
-</para>
-
-<para>
 <list type="tag">
 
 <tag-name id="s_allow"><literal>s.allow()</literal></tag-name>
@@ -351,106 +343,6 @@ on the <literal>warning</literal> level 
 </list>
 </para>
 
-
-<section id="stream_obsolete" name="Obsolete properties">
-
-<para>
-These properties have been removed
-in njs <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>
-and are not backward compatible with the existing njs code.
-</para>
-
-<para>
-<list type="tag">
-
-<tag-name id="s_abort"><literal>s.ABORT</literal></tag-name>
-<tag-desc>
-the <literal>ABORT</literal> return code
-<note>
-Starting from njs <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>,
-the <link id="s_deny">s.deny()</link> method should be used instead.
-</note>
-</tag-desc>
-
-<tag-name><literal>s.AGAIN</literal></tag-name>
-<tag-desc>
-the <literal>AGAIN</literal> return code
-<note>
-Starting from njs <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>,
-the corresponding behavior is achieved if no
-<link id="s_allow">s.allow()</link>,
-<link id="s_deny">s.deny()</link>,
-<link id="s_decline">s.decline()</link>,
-<link id="s_done">s.done()</link>
-is invoked and a callback is registered.
-</note>
-</tag-desc>
-
-<tag-name id="s_buffer"><literal>s.buffer</literal></tag-name>
-<tag-desc>
-the current buffer, writable
-<note>
-Starting from <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>,
-the <link id="s_send">s.send()</link> method should be used for writing.
-For reading, the current buffer is available as the first argument of the
-<literal>event</literal> callback.
-</note>
-</tag-desc>
-
-<tag-name><literal>s.DECLINED</literal></tag-name>
-<tag-desc>
-the <literal>DECLINED</literal> return code
-<note>
-Starting from njs <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>,
-the <link id="s_decline">s.decline()</link> method should be used instead.
-</note>
-</tag-desc>
-
-<tag-name><literal>s.eof</literal></tag-name>
-<tag-desc>
-a boolean read-only property, true if the current buffer is the last buffer
-<note>
-Starting from <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>,
-the <link id="s_on_callback_last">flags.last</link> property
-should be used instead.
-</note>
-</tag-desc>
-
-<tag-name><literal>s.ERROR</literal></tag-name>
-<tag-desc>
-the <literal>ERROR</literal> return code
-<note>
-Starting from njs <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>,
-an appropriate exception can be thrown to report an error.
-</note>
-</tag-desc>
-
-<tag-name><literal>s.fromUpstream</literal></tag-name>
-<tag-desc>
-a boolean read-only property,
-true if the current buffer is from the upstream server to the client
-<note>
-Starting from <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>,
-a corresponding <link id="s_on">event</link>
-(<literal>upload</literal> or <literal>download</literal>)
-should be used to handle data to or from client.
-</note>
-</tag-desc>
-
-<tag-name id="s_ok"><literal>s.OK</literal></tag-name>
-<tag-desc>
-the <literal>OK</literal> return code
-<note>
-Starting from njs <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>,
-the <link id="s_allow">s.allow()</link> method should be used instead.
-</note>
-</tag-desc>
-
-</list>
-</para>
-
-</section>
-
 </section>
 
 </section>
--- 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
 <section id="example" name="Example Configuration">
 
 <para>
-<note>
-This example is valid for
-njs <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>
-and later.
-For njs <link doc="../njs/changes.xml" id="njs0.2.3">0.2.3</link>
-and earlier, use
-<link doc="../njs/examples.xml" id="legacy">this</link> example.
-</note>
 <example>
 load_module modules/ngx_stream_js_module.so;
 ...
--- a/xml/ru/docs/njs/examples.xml
+++ b/xml/ru/docs/njs/examples.xml
@@ -9,7 +9,7 @@
 <article name="Примеры использования"
         link="/ru/docs/njs/examples.html"
         lang="ru"
-        rev="3">
+        rev="4">
 
 <section id="helloword" name="Hello World">
 
@@ -305,134 +305,4 @@ function create_secure_link(r) {
 
 </section>
 
-
-<section id="legacy" name="Устаревшие примеры">
-
-<section id="legacy_stream" name="Внедрение HTTP-заголовка при помощи stream proxy">
-
-<para>
-Начиная с версии njs <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>
-<link doc="../stream/ngx_stream_js_module.xml" id="example">пример</link>
-конфигурации в stream
-был изменён.
-Для njs <link doc="../njs/changes.xml" id="njs0.2.3">0.2.3</link>
-и более ранних версий необходимо использовать следующий пример конфигурации:
-<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;
-        }
-    }
-}
-</example>
-</para>
-
-<para>
-Файл <path>stream.js</path>:
-<example>
-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;
-    }
-}
-</example>
-</para>
-
-</section>
-
-</section>
-
 </article>
--- a/xml/ru/docs/njs/reference.xml
+++ b/xml/ru/docs/njs/reference.xml
@@ -357,108 +357,6 @@ true, если буфер должен иметь флаг <literal>flush</literal>
 </list>
 </para>
 
-<section id="stream_obsolete" name="Устаревшие свойства">
-
-<para>
-Данные свойства были удалены
-в njs версии <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>
-и не имеют обратной совместимости с существующим кодом njs.
-</para>
-
-<para>
-<list type="tag">
-
-<tag-name id="s_abort"><literal>s.ABORT</literal></tag-name>
-<tag-desc>
-код <literal>ABORT</literal>
-<note>
-Начиная с версии njs <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>
-необходимо использовать метод <link id="s_deny">s.deny()</link>.
-</note>
-</tag-desc>
-
-<tag-name><literal>s.AGAIN</literal></tag-name>
-<tag-desc>
-код <literal>AGAIN</literal>
-<note>
-Начиная с версии njs <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>
-соответствующее поведение достигается, если не вызываются
-<link id="s_allow">s.allow()</link>,
-<link id="s_deny">s.deny()</link>,
-<link id="s_decline">s.decline()</link>,
-<link id="s_done">s.done()</link>
-и callback зарегистрирован.
-</note>
-</tag-desc>
-
-<tag-name id="s_buffer"><literal>s.buffer</literal></tag-name>
-<tag-desc>
-текущий буфер, доступен для записи
-<note>
-Начиная с версии njs <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>
-для записи необходимо использовать метод <link id="s_send">s.send()</link>.
-Для чтения текущий буфер доступен в качестве первого аргумента
-callback'а <literal>event</literal>.
-</note>
-</tag-desc>
-
-<tag-name><literal>s.DECLINED</literal></tag-name>
-<tag-desc>
-код <literal>DECLINED</literal>
-<note>
-Начиная с версии njs <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>
-необходимо использовать метод <link id="s_decline">s.decline()</link>.
-</note>
-</tag-desc>
-
-<tag-name><literal>s.eof</literal></tag-name>
-<tag-desc>
-логическое свойство,
-true, если текущий буфер является последним буфером,
-только чтение
-<note>
-Начиная с версии njs <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>
-необходимо использовать свойство <link id="s_on_callback_last">flags.last</link>.
-</note>
-</tag-desc>
-
-<tag-name><literal>s.ERROR</literal></tag-name>
-<tag-desc>
-код <literal>ERROR</literal>
-<note>
-Начиная с версии njs <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>
-для сообщения об ошибке используется соответствующее исключение.
-</note>
-</tag-desc>
-
-<tag-name><literal>s.fromUpstream</literal></tag-name>
-<tag-desc>
-логическое свойство,
-true, если текущий буфер является буфером от проксируемого сервера к клиенту,
-только чтение
-<note>
-Начиная с версии njs <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>
-необходимо использовать
-соответствующее <link id="s_on">событие</link>
-(<literal>upload</literal> или <literal>download</literal>)
-для обработки данных к клиенту или от клиента.
-</note>
-</tag-desc>
-
-<tag-name id="s_ok"><literal>s.OK</literal></tag-name>
-<tag-desc>
-код <literal>OK</literal>
-<note>
-Начиная с версии njs <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>
-необходимо использовать метод <link id="s_allow">s.allow()</link>.
-</note>
-</tag-desc>
-
-</list>
-</para>
-
-</section>
-
 </section>
 
 </section>
--- a/xml/ru/docs/stream/ngx_stream_js_module.xml
+++ b/xml/ru/docs/stream/ngx_stream_js_module.xml
@@ -31,14 +31,6 @@
 <section id="example" name="Пример конфигурации">
 
 <para>
-<note>
-Данный пример необходимо использовать с
-версией njs <link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>
-и более поздними.
-Для версий njs <link doc="../njs/changes.xml" id="njs0.2.3">0.2.3</link>
-и ранее необходимо использовать
-<link doc="../njs/examples.xml" id="legacy">этот</link> пример.
-</note>
 <example>
 load_module modules/ngx_stream_js_module.so;
 ...