[sr-dev] git:master:32102e43: tmx: documentation for t_flush_xflags() function

[Daniel-Constantin Mierla]

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

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

tmx: documentation for t_flush_xflags() function

---

Modified: src/modules/tmx/doc/tmx_admin.xml

---

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

---

diff --git a/src/modules/tmx/doc/tmx_admin.xml b/src/modules/tmx/doc/tmx_admin.xml
index b767197537..9f6168bb0f 100644
--- a/src/modules/tmx/doc/tmx_admin.xml
+++ b/src/modules/tmx/doc/tmx_admin.xml
@@ -223,6 +223,27 @@ if (t_reply_callid("123qaz", "5", "458", "Replied remotely")) {
 ...
 t_flush_flags();
 ...
+</programlisting>
+		</example>
+	</section>
+	<section id="tmx.f.t_flush_xflags">
+		<title>
+		<function moreinfo="none">t_flush_xflags()</function>
+		</title>
+		<para>
+		Flush the extended flags from current SIP message into the already created
+		transaction. It make sense only in routing block if the transaction was
+		created via t_newtran() and the extended flags have been altered since.
+		</para>
+		<para>
+		This function can be used from ANY_ROUTE .
+		</para>
+		<example>
+		<title><function>t_flush_xflags</function> usage</title>
+		<programlisting format="linespecific">
+...
+t_flush_xflags();
+...
 </programlisting>
 		</example>
 	</section>