Ver código fonte

tmx: added the docs for t_flush_flags()

Daniel-Constantin Mierla 14 anos atrás
pai
commit
ce7aa8e46e
2 arquivos alterados com 38 adições e 0 exclusões
  1. 17 0
      modules_k/tmx/README
  2. 21 0
      modules_k/tmx/doc/tmx_admin.xml

+ 17 - 0
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

+ 21 - 0
modules_k/tmx/doc/tmx_admin.xml

@@ -168,6 +168,27 @@ if (t_reply_callid("123qaz", "5", "458", "Replied remotely")) {
 	xlog("transaction replied\n");
 }
 ...
+</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>