[sr-dev] git:master: tm: added missing documentation for t_check_status()

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Sat Sep 14 09:46:23 2013 +0200

tm: added missing documentation for t_check_status()

---

 modules/tm/doc/functions.xml |   40 ++++++++++++++++++++++++++++++++++++++++
 1 files changed, 40 insertions(+), 0 deletions(-)

diff --git a/modules/tm/doc/functions.xml b/modules/tm/doc/functions.xml
index b08c153..fe37914 100644
--- a/modules/tm/doc/functions.xml
+++ b/modules/tm/doc/functions.xml
@@ -1295,6 +1295,46 @@ event_route[tm:branch-failure:outbound]
 		</example>
 	</section>
 
+	<section id="tm.f.t_check_status">
+		<title>
+		<function moreinfo="none">t_check_status(re)</function>
+		</title>
+		<para>
+		Returns true if the regular expresion <quote>re</quote> match the
+		reply code of the response message as follows:
+		<itemizedlist>
+		<listitem>
+			<para><emphasis>in routing block</emphasis> - the code of the
+			last sent reply.
+			</para>
+		</listitem>
+		<listitem>
+			<para><emphasis>in on_reply block</emphasis> - the code of the
+			current received reply.
+			</para>
+		</listitem>
+		<listitem>
+			<para><emphasis>in on_failure block</emphasis> - the code of the
+			selected negative final reply.
+			</para>
+		</listitem>
+		</itemizedlist>
+		</para>
+		<para>
+		This function can be used from ANY_ROUTE .
+		</para>
+		<example>
+		<title><function>t_check_status</function> usage</title>
+		<programlisting format="linespecific">
+...
+if (t_check_status("(487)|(408)")) {
+    log("487 or 408 negative reply\n");
+}
+...
+</programlisting>
+		</example>
+	</section>
+
 	<section id="tm.f.t_check_trans">
 	<title>
 		<function>t_check_trans()</function>