Mercurial > hg > nginx-site

comparison xml/en/docs/njs/reference.xml @ 3014:c0a4a4a55e45

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented Periodic Session object in njs Reference.
author Yaroslav Zhuravlev <yar@nginx.com>
date Fri, 29 Sep 2023 20:06:59 +0100
parents 2e8c1384d211
children 3a85326ed38c
comparison
equal deleted inserted replaced
3013:1ad61bfc7630 3014:c0a4a4a55e45
7 <!DOCTYPE article SYSTEM "../../../../dtd/article.dtd"> 7 <!DOCTYPE article SYSTEM "../../../../dtd/article.dtd">
8 8
9 <article name="Reference" 9 <article name="Reference"
10 link="/en/docs/njs/reference.html" 10 link="/en/docs/njs/reference.html"
11 lang="en" 11 lang="en"
12 rev="116"> 12 rev="117">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 <link doc="index.xml">njs</link> provides objects, methods and properties 17 <link doc="index.xml">njs</link> provides objects, methods and properties
998 <link doc="../dev/development_guide.xml" id="logging">hardcoded</link> 998 <link doc="../dev/development_guide.xml" id="logging">hardcoded</link>
999 maximum line length limit, 999 maximum line length limit,
1000 only first 2048 bytes of the string can be logged. 1000 only first 2048 bytes of the string can be logged.
1001 </note> 1001 </note>
1002 </para> 1002 </para>
1003 </tag-desc>
1004
1005 </list>
1006 </para>
1007
1008 </section>
1009
1010
1011 <section id="periodic_session" name="Periodic Session">
1012
1013 <para>
1014 <table width="100%">
1015 <tr><td><link id="periodic_session_raw_variables"><literal>PeriodicSession.rawVariables{}</literal></link></td></tr>
1016 <tr><td><link id="periodic_session_variables"><literal>PeriodicSession.variables{}</literal></link></td></tr>
1017 </table>
1018 </para>
1019
1020 <para>
1021 The <literal>Periodic Session</literal> object is provided as the first argument
1022 for the <literal>js_periodic</literal> handler for
1023 <link doc="../http/ngx_http_js_module.xml" id="js_periodic">http</link>
1024 and
1025 <link doc="../stream/ngx_stream_js_module.xml" id="js_periodic">stream</link>
1026 (since <link doc="changes.xml" id="njs0.8.1">0.8.1</link>).
1027 </para>
1028
1029 <para>
1030 <list type="tag">
1031
1032 <tag-name id="periodic_session_raw_variables"><literal>PeriodicSession.rawVariables{}</literal></tag-name>
1033 <tag-desc>
1034 nginx <link id="periodic_session_variables">variables</link> as Buffers,
1035 writable.
1036 </tag-desc>
1037
1038 <tag-name id="periodic_session_variables"><literal>PeriodicSession.variables{}</literal></tag-name>
1039 <tag-desc>
1040 <link doc="../varindex.xml">nginx variables</link> object, writable.
1003 </tag-desc> 1041 </tag-desc>
1004 1042
1005 </list> 1043 </list>
1006 </para> 1044 </para>
1007 1045