Mercurial > hg > nginx-site
diff xml/en/docs/njs/reference.xml @ 2246:32ba43abf9cd
Renamed njs API, njs Changes.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Mon, 24 Sep 2018 19:24:04 +0300 |
parents | xml/en/docs/njs/njs_api.xml@87a0e2c73a25 |
children | 0f16ef9a8dbe |
line wrap: on
line diff
copy from xml/en/docs/njs/njs_api.xml copy to xml/en/docs/njs/reference.xml --- a/xml/en/docs/njs/njs_api.xml +++ b/xml/en/docs/njs/reference.xml @@ -6,10 +6,10 @@ <!DOCTYPE article SYSTEM "../../../../dtd/article.dtd"> -<article name="njs API" - link="/en/docs/njs/njs_api.html" +<article name="Reference" + link="/en/docs/njs/reference.html" lang="en" - rev="8"> + rev="9"> <section id="summary"> @@ -1041,7 +1041,7 @@ All string properties of the object are <para> <note> -Prior to njs <link doc="../njs/njs_changes.xml" id="njs0.2.4">0.2.4</link>, +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> @@ -1053,26 +1053,26 @@ the stream session object had some prope <tag-name id="s_allow"><literal>s.allow()</literal></tag-name> <tag-desc> successfully finalizes the phase handler -(<link doc="../njs/njs_changes.xml" id="njs0.2.4">0.2.4</link>) +(<link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>) </tag-desc> <tag-name id="s_decline"><literal>s.decline()</literal></tag-name> <tag-desc> finalizes the phase handler and passes control to the next handler -(<link doc="../njs/njs_changes.xml" id="njs0.2.4">0.2.4</link>) +(<link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>) </tag-desc> <tag-name id="s_deny"><literal>s.deny()</literal></tag-name> <tag-desc> finalizes the phase handler with the access error code -(<link doc="../njs/njs_changes.xml" id="njs0.2.4">0.2.4</link>) +(<link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>) </tag-desc> <tag-name id="s_done"><literal>s.done</literal>(<value>[code]</value>)</tag-name> <tag-desc> successfully finalizes the current phase handler or finalizes it with the specified numeric code -(<link doc="../njs/njs_changes.xml" id="njs0.2.4">0.2.4</link>). +(<link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>). </tag-desc> <tag-name><literal>s.error(<value>string</value>)</literal></tag-name> @@ -1090,14 +1090,14 @@ on the <literal>info</literal> level of <tag-name id="s_off"><literal>s.off(<value>eventName</value>)</literal></tag-name> <tag-desc> unregisters the callback set by the <link id="s_on">s.on()</link> method -(<link doc="../njs/njs_changes.xml" id="njs0.2.4">0.2.4</link>) +(<link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>) </tag-desc> <tag-name id="s_on"><literal>s.on(<value>event</value>, <value>callback</value>)</literal></tag-name> <tag-desc> registers a <literal>callback</literal> for the specified <literal>event</literal> -(<link doc="../njs/njs_changes.xml" id="njs0.2.4">0.2.4</link>). +(<link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>). <para> An <literal>event</literal> may be one of the following strings: @@ -1140,7 +1140,7 @@ client address, read-only <value>options</value>])</literal></tag-name> <tag-desc> sends the data to the client -(<link doc="../njs/njs_changes.xml" id="njs0.2.4">0.2.4</link>). +(<link doc="../njs/changes.xml" id="njs0.2.4">0.2.4</link>). The <literal>options</literal> is an object used to override nginx buffer flags derived from an incoming data chunk buffer. The flags can be overriden with the following flags: @@ -1180,7 +1180,7 @@ on the <literal>warning</literal> level <para> These properties have been removed -in njs <link doc="../njs/njs_changes.xml" id="njs0.2.4">0.2.4</link> +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> @@ -1191,7 +1191,7 @@ and are not backward compatible with the <tag-desc> the <literal>ABORT</literal> return code <note> -Starting from njs <link doc="../njs/njs_changes.xml" id="njs0.2.4">0.2.4</link>, +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> @@ -1200,7 +1200,7 @@ the <link id="s_deny">s.deny()</link> me <tag-desc> the <literal>AGAIN</literal> return code <note> -Starting from njs <link doc="../njs/njs_changes.xml" id="njs0.2.4">0.2.4</link>, +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>, @@ -1214,7 +1214,7 @@ is invoked and a callback is registered. <tag-desc> the current buffer, writable <note> -Starting from <link doc="../njs/njs_changes.xml" id="njs0.2.4">0.2.4</link>, +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. @@ -1225,7 +1225,7 @@ For reading, the current buffer is avail <tag-desc> the <literal>DECLINED</literal> return code <note> -Starting from njs <link doc="../njs/njs_changes.xml" id="njs0.2.4">0.2.4</link>, +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> @@ -1234,7 +1234,7 @@ the <link id="s_decline">s.decline()</li <tag-desc> a boolean read-only property, true if the current buffer is the last buffer <note> -Starting from <link doc="../njs/njs_changes.xml" id="njs0.2.4">0.2.4</link>, +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> @@ -1244,7 +1244,7 @@ should be used instead. <tag-desc> the <literal>ERROR</literal> return code <note> -Starting from njs <link doc="../njs/njs_changes.xml" id="njs0.2.4">0.2.4</link>, +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> @@ -1254,7 +1254,7 @@ an appropriate exception can be thrown t a boolean read-only property, true if the current buffer is from the upstream server to the client <note> -Starting from <link doc="../njs/njs_changes.xml" id="njs0.2.4">0.2.4</link>, +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. @@ -1265,7 +1265,7 @@ should be used to handle data to or from <tag-desc> the <literal>OK</literal> return code <note> -Starting from njs <link doc="../njs/njs_changes.xml" id="njs0.2.4">0.2.4</link>, +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>