[sr-dev] git:master: tmx: added the docs for t_flush_flags()

[Daniel-Constantin Mierla]

Module: sip-router
Branch: master
Commit: ce7aa8e46e839a56d5759a688d03515f94497267
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=ce7aa8e46e839a56d5759a688d03515f94497267

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Sat Mar 12 12:27:52 2011 +0100

tmx: added the docs for t_flush_flags()

---

 modules_k/tmx/README            |   17 +++++++++++++++++
 modules_k/tmx/doc/tmx_admin.xml |   21 +++++++++++++++++++++
 2 files changed, 38 insertions(+), 0 deletions(-)

diff --git a/modules_k/tmx/README b/modules_k/tmx/README
index 6b3f050..7f62959 100644
--- a/modules_k/tmx/README
+++ b/modules_k/tmx/README
@@ -29,6 +29,7 @@ Daniel-Constantin Mierla
               3.1. t_cancel_branches(which)
               3.2. t_cancel_callid(callid, cseq, flag)
               3.3. t_reply_callid(callid, cseq, code, reason)
+              3.4. t_flush_flags()
 
         4. Exported pseudo-variables
         5. Exported MI Functions
@@ -57,6 +58,7 @@ Daniel-Constantin Mierla
    1.1. t_cancel_branches usage
    1.2. t_cancel_callid usage
    1.3. t_reply_callid usage
+   1.4. t_flush_flags usage
 
 Chapter 1. Admin Guide
 
@@ -73,6 +75,7 @@ Chapter 1. Admin Guide
         3.1. t_cancel_branches(which)
         3.2. t_cancel_callid(callid, cseq, flag)
         3.3. t_reply_callid(callid, cseq, code, reason)
+        3.4. t_flush_flags()
 
    4. Exported pseudo-variables
    5. Exported MI Functions
@@ -124,6 +127,7 @@ Chapter 1. Admin Guide
    3.1. t_cancel_branches(which)
    3.2. t_cancel_callid(callid, cseq, flag)
    3.3. t_reply_callid(callid, cseq, code, reason)
+   3.4. t_flush_flags()
 
 3.1.  t_cancel_branches(which)
 
@@ -182,6 +186,19 @@ if (t_reply_callid("123qaz", "5", "458", "Replied remotely")) {
 }
 ...
 
+3.4.  t_flush_flags()
+
+   Flush the 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 flags have been altered since.
+
+   This function can be used from ANY_ROUTE .
+
+   Example 1.4. t_flush_flags usage
+...
+t_flush_flags();
+...
+
 4. Exported pseudo-variables
 
      * $T_branch_idx
diff --git a/modules_k/tmx/doc/tmx_admin.xml b/modules_k/tmx/doc/tmx_admin.xml
index 1012972..ccdb791 100644
--- a/modules_k/tmx/doc/tmx_admin.xml
+++ b/modules_k/tmx/doc/tmx_admin.xml
@@ -171,6 +171,27 @@ if (t_reply_callid("123qaz", "5", "458", "Replied remotely")) {
 </programlisting>
 		</example>
 	</section>
+	<section>
+		<title>
+		<function moreinfo="none">t_flush_flags()</function>
+		</title>
+		<para>
+		Flush the 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 flags have been altered since.
+		</para>
+		<para>
+		This function can be used from ANY_ROUTE .
+		</para>
+		<example>
+		<title><function>t_flush_flags</function> usage</title>
+		<programlisting format="linespecific">
+...
+t_flush_flags();
+...
+</programlisting>
+		</example>
+	</section>
 	</section>
 
 	<section>