pv: add documentation of xavi related functions [skip ci]
authorVictor Seva <linuxmaniac@torreviejawireless.org>
Fri, 29 May 2020 07:21:34 +0000 (09:21 +0200)
committerVictor Seva <linuxmaniac@torreviejawireless.org>
Fri, 29 May 2020 21:31:55 +0000 (23:31 +0200)
src/modules/pv/doc/pv_admin.xml

index 88ca172..8b4b0aa 100644 (file)
@@ -443,6 +443,32 @@ xavp_child_seti("x", "y", "$var(n)");
                                </programlisting>
                        </example>
                </section>
+               <section id="pv.f.xavi_child_seti">
+                       <title>
+                               <function moreinfo="none">xavi_child_seti(rname, cname, ival)</function>
+                       </title>
+                       <para>
+                               Set the value of $xavi(rname=&gt;cname) to integer value ival.
+                       </para>
+                       <para>
+                               The first parameter has to be the name of XAVI in the root list.
+                               The second parameter name of child XAVI. The third parameter
+                               can be an integer number or a variable holding an integer.
+                       </para>
+                       <para>
+                       Function can be used from ANY ROUTE.
+                       </para>
+                       <example>
+                               <title><function>xavi_child_seti</function> usage</title>
+                               <programlisting format="linespecific">
+...
+$var(n) = 10;
+xavi_child_seti("WhatEver", "FoO", "$var(n)");
+# results in: $xavi(whatever=&gt;foo) is 10
+...
+                               </programlisting>
+                       </example>
+               </section>
                <section id="pv.f.xavp_child_sets">
                        <title>
                                <function moreinfo="none">xavp_child_sets(rname, cname, sval)</function>
@@ -469,6 +495,32 @@ xavp_child_sets("x", "y", "Count: $var(n)");
                                </programlisting>
                        </example>
                </section>
+               <section id="pv.f.xavi_child_sets">
+                       <title>
+                               <function moreinfo="none">xavi_child_sets(rname, cname, sval)</function>
+                       </title>
+                       <para>
+                               Set the value of $xavi(rname=&gt;cname) to string value sval.
+                       </para>
+                       <para>
+                               The first parameter has to be the name of XAVI in the root list.
+                               The second parameter name of child XAVI. The third parameter
+                               can be a static or dynamic (with variables) string.
+                       </para>
+                       <para>
+                       Function can be used from ANY ROUTE.
+                       </para>
+                       <example>
+                               <title><function>xavi_child_sets</function> usage</title>
+                               <programlisting format="linespecific">
+...
+$var(n) = 10;
+xavi_child_sets("WhatEver", "FoO", "Count: $var(n)");
+# results in: $xavi(whatever=&gt;foo) is "Count: 10"
+...
+                               </programlisting>
+                       </example>
+               </section>
                <section id="pv.f.xavp_rm">
                        <title>
                                <function moreinfo="none">xavp_rm(rname)</function>
@@ -493,7 +545,30 @@ xavp_rm("x");
                                </programlisting>
                        </example>
                </section>
-
+               <section id="pv.f.xavi_rm">
+                       <title>
+                               <function moreinfo="none">xavi_rm(rname)</function>
+                       </title>
+                       <para>
+                               Remove the value of $xavi(rname).
+                       </para>
+                       <para>
+                               The parameter has to be the name of XAVI in the root list.
+                               It can be static or dynamic string (to include variables).
+                       </para>
+                       <para>
+                       Function can be used from ANY ROUTE.
+                       </para>
+                       <example>
+                               <title><function>xavi_rm</function> usage</title>
+                               <programlisting format="linespecific">
+...
+xavi_rm("WhatEver");
+# same result as: $xavi(whatever) = $null;
+...
+                               </programlisting>
+                       </example>
+               </section>
                <section id="pv.f.xavp_child_rm">
                        <title>
                                <function moreinfo="none">xavp_child_rm(rname, cname)</function>
@@ -519,6 +594,31 @@ xavp_child_rm("x", "y");
                                </programlisting>
                        </example>
                </section>
+               <section id="pv.f.xavi_child_rm">
+                       <title>
+                               <function moreinfo="none">xavi_child_rm(rname, cname)</function>
+                       </title>
+                       <para>
+                               Remove the value of $xavi(rname=&gt;cname).
+                       </para>
+                       <para>
+                               The first parameter has to be the name of XAVI in the root list.
+                               The second parameter name of child XAVI. Both parameters can be
+                               static or dynamic strings (to include variables).
+                       </para>
+                       <para>
+                       Function can be used from ANY ROUTE.
+                       </para>
+                       <example>
+                               <title><function>xavi_child_rm</function> usage</title>
+                               <programlisting format="linespecific">
+...
+xavi_child_rm("WhatEver", "FoO");
+# same result as: $xavi(whatever=&gt;foo) = $null;
+...
+                               </programlisting>
+                       </example>
+               </section>
                <section id="pv.f.sbranch_set_ruri">
                        <title>
                                <function moreinfo="none">sbranch_set_ruri()</function>
@@ -636,6 +736,25 @@ pv_xavu_print();
                                </programlisting>
                        </example>
                </section>
+               <section id="pv.f.pv_xavi_print">
+                       <title>
+                               <function moreinfo="none">pv_xavi_print()</function>
+                       </title>
+                       <para>
+                               Print all XAVIs to the syslog using INFO log level.
+                       </para>
+                       <para>
+                       Function can be used from ANY_ROUTE.
+                       </para>
+                       <example>
+                               <title><function>pv_xavi_print()</function> usage</title>
+                               <programlisting format="linespecific">
+...
+pv_xavi_print();
+...
+                               </programlisting>
+                       </example>
+               </section>
                <section id="pv.f.pv_var_to_xavp">
                        <title>
                                <function moreinfo="none">pv_var_to_xavp(varname, xname)</function>