[sr-dev] git:master: tm: added t_use_uac_headers() to documentation

Module: sip-router Branch: master Commit: b5b570f278124bf0456d43a36a7c0eb5eaa9efe6 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=b5b570f… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: Tue Oct 1 09:34:17 2013 +0200 tm: added t_use_uac_headers() to documentation --- modules/tm/README | 21 +++++++++++++++++++-- modules/tm/doc/functions.xml | 20 ++++++++++++++++++++ 2 files changed, 39 insertions(+), 2 deletions(-) diff --git a/modules/tm/README b/modules/tm/README index 6b9e8b5..8c6fde0 100644 --- a/modules/tm/README +++ b/modules/tm/README @@ -119,6 +119,7 @@ Juha Heinanen 5.47. t_relay_to(proxy, flags) 5.48. t_set_no_e2e_cancel_reason(0|1) 5.49. t_is_set(target) + 5.50. t_use_uac_headers() 6. TM Module API @@ -229,7 +230,8 @@ Juha Heinanen 1.85. t_replicate usage 1.86. t_set_no_e2e_cancel_reason usage 1.87. t_replicate usage - 1.88. event_route[tm:branch-failure] usage + 1.88. t_use_uac_headers usage + 1.89. event_route[tm:branch-failure] usage Chapter 1. Admin Guide @@ -337,6 +339,7 @@ Chapter 1. Admin Guide 5.47. t_relay_to(proxy, flags) 5.48. t_set_no_e2e_cancel_reason(0|1) 5.49. t_is_set(target) + 5.50. t_use_uac_headers() 6. TM Module API @@ -1606,6 +1609,7 @@ modparam("tm", "dns_reuse_rcv_socket", 1) 5.47. t_relay_to(proxy, flags) 5.48. t_set_no_e2e_cancel_reason(0|1) 5.49. t_is_set(target) + 5.50. t_use_uac_headers() 5.1. t_relay([host, port]) @@ -2651,6 +2655,19 @@ if(!t_is_set("failure_route")) LM_DBG("no failure route will be executed for current transaction\n"); ... +5.50. t_use_uac_headers() + + Set internal flags to tell tm to use UAC side for building headers for + local generated requests (ACK, CANCEL) - useful when changing From/To + headers using other functions than uac_replace_[from|to](). + + It returns true. + + Example 1.88. t_use_uac_headers usage +... +t_use_uac_headers(); +... + 6. TM Module API 6.1. Defines @@ -2832,7 +2849,7 @@ action *route) enabled with the t_on_branch_failure function. This event_route uses the BRANCH_FAILURE_ROUTE route type. - Example 1.88. event_route[tm:branch-failure] usage + Example 1.89. event_route[tm:branch-failure] usage ... route { t_on_branch_failure("myroute"); diff --git a/modules/tm/doc/functions.xml b/modules/tm/doc/functions.xml index fe37914..fba4e92 100644 --- a/modules/tm/doc/functions.xml +++ b/modules/tm/doc/functions.xml @@ -1701,4 +1701,24 @@ if(!t_is_set("failure_route")) </example> </section> + <section id="tm.f.t_use_uac_headers"> + <title> + <function>t_use_uac_headers()</function> + </title> + <para> + Set internal flags to tell tm to use UAC side for building headers for + local generated requests (ACK, CANCEL) - useful when changing From/To + headers using other functions than uac_replace_[from|to](). + </para> + <para>It returns true.</para> + <example> + <title><function>t_use_uac_headers</function> usage</title> + <programlisting> +... +t_use_uac_headers(); +... + </programlisting> + </example> + </section> + </section>