[sr-dev] git:master: tmx: documented reason code parameter for t_cancel_callid()

Module: sip-router Branch: master Commit: ce7aee6e59d2b4980625f9c4dfef171048341319 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=ce7aee6… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: Fri Jul 25 17:17:22 2014 +0200 tmx: documented reason code parameter for t_cancel_callid() --- modules/tmx/README | 14 ++++++++++---- modules/tmx/doc/tmx_admin.xml | 11 ++++++++++- 2 files changed, 20 insertions(+), 5 deletions(-) diff --git a/modules/tmx/README b/modules/tmx/README index 9a6b472..73eba24 100644 --- a/modules/tmx/README +++ b/modules/tmx/README @@ -38,7 +38,7 @@ Juha Heinanen 3. Functions 3.1. t_cancel_branches(which) - 3.2. t_cancel_callid(callid, cseq, flag) + 3.2. t_cancel_callid(callid, cseq, flag [, rcode]) 3.3. t_reply_callid(callid, cseq, code, reason) 3.4. t_flush_flags() 3.5. t_is_failure_route() @@ -97,7 +97,7 @@ Chapter 1. Admin Guide 3. Functions 3.1. t_cancel_branches(which) - 3.2. t_cancel_callid(callid, cseq, flag) + 3.2. t_cancel_callid(callid, cseq, flag [, rcode]) 3.3. t_reply_callid(callid, cseq, code, reason) 3.4. t_flush_flags() 3.5. t_is_failure_route() @@ -156,7 +156,7 @@ Chapter 1. Admin Guide 3. Functions 3.1. t_cancel_branches(which) - 3.2. t_cancel_callid(callid, cseq, flag) + 3.2. t_cancel_callid(callid, cseq, flag [, rcode]) 3.3. t_reply_callid(callid, cseq, code, reason) 3.4. t_flush_flags() 3.5. t_is_failure_route() @@ -185,7 +185,7 @@ if (t_cancel_branches("all")) { } ... -3.2. t_cancel_callid(callid, cseq, flag) +3.2. t_cancel_callid(callid, cseq, flag [, rcode]) Cancel first INVITE transaction identified by callid and cseq. It sets the flag if the value is greater than zero @@ -194,6 +194,8 @@ if (t_cancel_branches("all")) { * callid - call-id value. * cseq - cseq number. * flag - index of the flag to set. + * rcode - code to be added as cause attribute in Reason header for + generated CANCEL request. This parameter is optional. This function can be used in ANY_ROUTE. @@ -203,6 +205,10 @@ if (t_cancel_callid("123qaz", "5", "22")) { xlog("transaction cancelled\n"); } ... +if (t_cancel_callid("123qaz", "5", "22", "200")) { + xlog("transaction cancelled with [Reason: cause=200]\n"); +} +... 3.3. t_reply_callid(callid, cseq, code, reason) diff --git a/modules/tmx/doc/tmx_admin.xml b/modules/tmx/doc/tmx_admin.xml index 9042763..643281b 100644 --- a/modules/tmx/doc/tmx_admin.xml +++ b/modules/tmx/doc/tmx_admin.xml @@ -97,7 +97,7 @@ if (t_cancel_branches("all")) { </section> <section> <title> - <function moreinfo="none">t_cancel_callid(callid, cseq, flag) + <function moreinfo="none">t_cancel_callid(callid, cseq, flag [, rcode]) </function> </title> <para> @@ -117,6 +117,11 @@ if (t_cancel_branches("all")) { <listitem><para> <emphasis>flag</emphasis> - index of the flag to set. </para></listitem> + <listitem><para> + <emphasis>rcode</emphasis> - code to be added as + cause attribute in Reason header for generated + CANCEL request. This parameter is optional. + </para></listitem> </itemizedlist> <para> This function can be used in ANY_ROUTE. @@ -129,6 +134,10 @@ if (t_cancel_callid("123qaz", "5", "22")) { xlog("transaction cancelled\n"); } ... +if (t_cancel_callid("123qaz", "5", "22", "200")) { + xlog("transaction cancelled with [Reason: cause=200]\n"); +} +... </programlisting> </example> </section>