[sr-dev] git:master:fd20e46b: corex: documentation for xflags management functions

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: fd20e46b280535753b9bf1b32da80a637a8fea26
URL: https://github.com/kamailio/kamailio/commit/fd20e46b280535753b9bf1b32da80a637a8fea26

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2018-03-14T13:03:48+01:00

corex: documentation for xflags management functions

---

Modified: src/modules/corex/doc/corex_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/fd20e46b280535753b9bf1b32da80a637a8fea26.diff
Patch: https://github.com/kamailio/kamailio/commit/fd20e46b280535753b9bf1b32da80a637a8fea26.patch

---

diff --git a/src/modules/corex/doc/corex_admin.xml b/src/modules/corex/doc/corex_admin.xml
index 0df7d12cf9..f401c3e022 100644
--- a/src/modules/corex/doc/corex_admin.xml
+++ b/src/modules/corex/doc/corex_admin.xml
@@ -409,6 +409,93 @@ if(file_write("/tmp/data.txt", "Data is: $var(data)")) { ... }
 </programlisting>
 		</example>
 	</section>
+		<section id="corex.f.setxflag">
+		<title><function moreinfo="none">setxflag(flag)</function></title>
+		<para>
+			Set the extended message (transaction) flag.
+		</para>
+		<para>Meaning of the parameters is as follows:</para>
+		<itemizedlist>
+		<listitem>
+			<para>
+				<emphasis>flag</emphasis> - the index of the flag to
+				be set. Can be integer or pseudo-variable with integer value
+				(range 0-63).
+			</para>
+		</listitem>
+		</itemizedlist>
+		<para>
+		This function can be used from ANY_ROUTE.
+		</para>
+		<example>
+		<title><function>setxflag</function> usage</title>
+		<programlisting format="linespecific">
+...
+setxflag("1");
+...
+$var(flag) = 11;
+setxflag("$var(flag)");
+...
+</programlisting>
+		</example>
+		</section>
+		<section id="corex.f.isxflagset">
+		<title><function moreinfo="none">isxflagset(flag)</function></title>
+		<para>
+			Return true of the extended message (transaction) flag is set.
+		</para>
+		<para>Meaning of the parameters is as follows:</para>
+		<itemizedlist>
+		<listitem>
+			<para>
+				<emphasis>flag</emphasis> - the index of the flag to
+				be tested. Can be integer or pseudo-variable with integer value
+				(range 0-63).
+			</para>
+		</listitem>
+		</itemizedlist>
+		<para>
+		This function can be used from ANY_ROUTE.
+		</para>
+		<example>
+		<title><function>isxflagset</function> usage</title>
+		<programlisting format="linespecific">
+...
+if(isxflagset("1"))
+{
+    ...
+}
+...
+</programlisting>
+		</example>
+		</section>
+		<section id="corex.f.resetxflag">
+		<title><function moreinfo="none">resetxflag(flag)</function></title>
+		<para>
+			Reset the extended message (transaction) flag.
+		</para>
+		<para>Meaning of the parameters is as follows:</para>
+		<itemizedlist>
+		<listitem>
+			<para>
+				<emphasis>flag</emphasis> - the index of the flag to
+				be reset. Can be integer or pseudo-variable with integer value
+				(range 0-63).
+			</para>
+		</listitem>
+		</itemizedlist>
+		<para>
+		This function can be used from ANY_ROUTE.
+		</para>
+		<example>
+		<title><function>resetxflag</function> usage</title>
+		<programlisting format="linespecific">
+...
+resetxflag("1");
+...
+</programlisting>
+		</example>
+		</section>
 
 	</section>