Mercurial > hg > nginx-site
diff xml/en/docs/njs/reference.xml @ 2332:9d502d4305ac
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 | 867fe207f13e |
line wrap: on
line diff
--- a/xml/en/docs/njs/reference.xml Tue Feb 26 18:11:41 2019 +0300 +++ b/xml/en/docs/njs/reference.xml Tue Feb 26 18:22:40 2019 +0300 @@ -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 @@ </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 @@ </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>