[sr-dev] git:master: dialog: documented the track_cseq_updates module parameter

Module: sip-router Branch: master Commit: 9108218677d52c4ca2b430bcfcae72fe574c85cd URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=9108218… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: Fri Sep 5 15:31:30 2014 +0200 dialog: documented the track_cseq_updates module parameter --- modules/dialog/README | 89 +++++++++++++++++++++------------- modules/dialog/doc/dialog_admin.xml | 30 +++++++++++- 2 files changed, 84 insertions(+), 35 deletions(-) diff --git a/modules/dialog/README b/modules/dialog/README index 37b2bc4..1267bd1 100644 --- a/modules/dialog/README +++ b/modules/dialog/README @@ -91,6 +91,7 @@ Alex Balashov 5.48. ka_interval (int) 5.49. timeout_noreset (int) 5.50. timer_procs (int) + 5.51. track_cseq_updates (int) 6. Functions @@ -218,23 +219,24 @@ Alex Balashov 1.48. Set ka_interval parameter 1.49. Set timeout_noreset parameter 1.50. Set timeout_procs parameter - 1.51. set_dlg_profile usage - 1.52. unset_dlg_profile usage - 1.53. is_in_profile usage - 1.54. get_profile_size usage - 1.55. dlg_isflagset usage - 1.56. dlg_setflag usage - 1.57. dlg_resetflag usage - 1.58. dlg_bye usage - 1.59. dlg_refer usage - 1.60. dlg_manage usage - 1.61. dlg_bridge usage - 1.62. dlg_get usage - 1.63. is_known_dlg() usage - 1.64. dlg_set_timeout usage - 1.65. dlg_set_timeout_by_profile usage - 1.66. dlg_set_property usage - 1.67. dlg_remote_profile usage + 1.51. Set track_cseq_updates parameter + 1.52. set_dlg_profile usage + 1.53. unset_dlg_profile usage + 1.54. is_in_profile usage + 1.55. get_profile_size usage + 1.56. dlg_isflagset usage + 1.57. dlg_setflag usage + 1.58. dlg_resetflag usage + 1.59. dlg_bye usage + 1.60. dlg_refer usage + 1.61. dlg_manage usage + 1.62. dlg_bridge usage + 1.63. dlg_get usage + 1.64. is_known_dlg() usage + 1.65. dlg_set_timeout usage + 1.66. dlg_set_timeout_by_profile usage + 1.67. dlg_set_property usage + 1.68. dlg_remote_profile usage Chapter 1. Admin Guide @@ -300,6 +302,7 @@ Chapter 1. Admin Guide 5.48. ka_interval (int) 5.49. timeout_noreset (int) 5.50. timer_procs (int) + 5.51. track_cseq_updates (int) 6. Functions @@ -502,6 +505,7 @@ Chapter 1. Admin Guide 5.48. ka_interval (int) 5.49. timeout_noreset (int) 5.50. timer_procs (int) + 5.51. track_cseq_updates (int) 5.1. enable_stats (integer) @@ -1154,6 +1158,23 @@ modparam("dialog", "timeout_noreset", 1) modparam("dialog", "timer_procs", 1) ... +5.51. track_cseq_updates (int) + + Enable the callbacks for tracking if CSeq number needs to be updated. + It is the case when the INVITE has to be authenticated to downstream + provider using uac_auth() from uac module. + + This is done only for requests in downstream direction. The CSeq + difference is stored in $dlg_var(cseq_diff), be sure this variable is + not overwritten via config operation. + + Default value is "0" (disabled). + + Example 1.51. Set track_cseq_updates parameter +... +modparam("dialog", "track_cseq_updates", 1) +... + 6. Functions 6.1. set_dlg_profile(profile,[value]) @@ -1190,7 +1211,7 @@ modparam("dialog", "timer_procs", 1) This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE and FAILURE_ROUTE. - Example 1.51. set_dlg_profile usage + Example 1.52. set_dlg_profile usage ... set_dlg_profile("inbound_call"); set_dlg_profile("caller","$fu"); @@ -1209,7 +1230,7 @@ set_dlg_profile("caller","$fu"); This function can be used from BRANCH_ROUTE, REPLY_ROUTE and FAILURE_ROUTE. - Example 1.52. unset_dlg_profile usage + Example 1.53. unset_dlg_profile usage ... unset_dlg_profile("inbound_call"); unset_dlg_profile("caller","$fu"); @@ -1232,7 +1253,7 @@ unset_dlg_profile("caller","$fu"); This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE and FAILURE_ROUTE. - Example 1.53. is_in_profile usage + Example 1.54. is_in_profile usage ... if (is_in_profile("inbound_call")) { log("this request belongs to a inbound call\n"); @@ -1261,7 +1282,7 @@ if (is_in_profile("caller","XX")) { This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE and FAILURE_ROUTE. - Example 1.54. get_profile_size usage + Example 1.55. get_profile_size usage ... if(get_profile_size("inbound_call","$avp(size)")) xlog("currently there are $avp(size) inbound calls\n"); @@ -1280,7 +1301,7 @@ if(get_profile_size("caller","$fu","$avp(size)")) This function can be used from BRANCH_ROUTE, REQUEST_ROUTE, ONREPLY_ROUTE and FAILURE_ROUTE. - Example 1.55. dlg_isflagset usage + Example 1.56. dlg_isflagset usage ... if(dlg_isflagset("1")) { @@ -1298,7 +1319,7 @@ if(dlg_isflagset("1")) This function can be used from BRANCH_ROUTE, REQUEST_ROUTE, ONREPLY_ROUTE and FAILURE_ROUTE. - Example 1.56. dlg_setflag usage + Example 1.57. dlg_setflag usage ... dlg_setflag("1"); ... @@ -1313,7 +1334,7 @@ dlg_setflag("1"); This function can be used from BRANCH_ROUTE, REQUEST_ROUTE, ONREPLY_ROUTE and FAILURE_ROUTE. - Example 1.57. dlg_resetflag usage + Example 1.58. dlg_resetflag usage ... redlg_setflag("1"); ... @@ -1329,7 +1350,7 @@ redlg_setflag("1"); This function can be used from BRANCH_ROUTE, REQUEST_ROUTE, ONREPLY_ROUTE and FAILURE_ROUTE. - Example 1.58. dlg_bye usage + Example 1.59. dlg_bye usage ... dlg_bye("all"); ... @@ -1346,7 +1367,7 @@ dlg_bye("all"); This function can be used from BRANCH_ROUTE, REQUEST_ROUTE, ONREPLY_ROUTE and FAILURE_ROUTE. - Example 1.59. dlg_refer usage + Example 1.60. dlg_refer usage ... dlg_refer("caller", "sip:announcement@kamailio.org"); ... @@ -1359,7 +1380,7 @@ dlg_refer("caller", "sip:announcement@kamailio.org"); This function can be used from REQUEST_ROUTE. - Example 1.60. dlg_manage usage + Example 1.61. dlg_manage usage ... modparam("dialog", "default_timeout", 100) ... @@ -1387,7 +1408,7 @@ route { This function can be used from BRANCH_ROUTE, REQUEST_ROUTE, ONREPLY_ROUTE and FAILURE_ROUTE. - Example 1.61. dlg_bridge usage + Example 1.62. dlg_bridge usage ... dlg_bridge("sip:user@kamailio.org", "sip:annoucement@kamailio.org", "sip:kamailio.org:5080"); @@ -1406,7 +1427,7 @@ dlg_bridge("sip:user@kamailio.org", "sip:annoucement@kamailio.org", This function can be used from BRANCH_ROUTE, REQUEST_ROUTE, ONREPLY_ROUTE and FAILURE_ROUTE. - Example 1.62. dlg_get usage + Example 1.63. dlg_get usage ... if(dlg_get("abcdef", "123", "456")) { @@ -1430,7 +1451,7 @@ if(dlg_get("abcdef", "123", "456")) This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE and FAILURE_ROUTE. - Example 1.63. is_known_dlg() usage + Example 1.64. is_known_dlg() usage ... if(!uri == myself) { if(is_known_dlg()) { @@ -1454,7 +1475,7 @@ if(!uri == myself) { This function can be used from ANY_ROUTE. - Example 1.64. dlg_set_timeout usage + Example 1.65. dlg_set_timeout usage ... if(dlg_set_timeout("180", "123", "456")) { @@ -1476,7 +1497,7 @@ if(dlg_set_timeout("180", "123", "456")) This function can be used from ANY_ROUTE. - Example 1.65. dlg_set_timeout_by_profile usage + Example 1.66. dlg_set_timeout_by_profile usage ... # All dialogs belonging to user abc123 (tracked via set_dlg_profile()) # will be timed out in 3 seconds. @@ -1508,7 +1529,7 @@ dlg_set_timeout_by_profile("users", "abc123", "3"); This function can be used from ANY_ROUTE. - Example 1.66. dlg_set_property usage + Example 1.67. dlg_set_property usage ... dlg_set_property("ka-src"); dlg_set_property("ka-dst"); @@ -1536,7 +1557,7 @@ dlg_set_property("timeout-noreset"); This function can be used from ANY_ROUTE. - Example 1.67. dlg_remote_profile usage + Example 1.68. dlg_remote_profile usage ... $var(exp) = 3600 + $Ts; dlg_remote_profile("add", "caller", "test", "$sruid", "$var(exp)"); diff --git a/modules/dialog/doc/dialog_admin.xml b/modules/dialog/doc/dialog_admin.xml index 3feb5f3..af46ab3 100644 --- a/modules/dialog/doc/dialog_admin.xml +++ b/modules/dialog/doc/dialog_admin.xml @@ -1269,7 +1269,7 @@ modparam("dialog", "timeout_noreset", 1) </emphasis> </para> <example> - <title>Set <varname>timeout_procs</varname> parameter</title> + <title>Set <varname>timer_procs</varname> parameter</title> <programlisting format="linespecific"> ... modparam("dialog", "timer_procs", 1) @@ -1278,6 +1278,34 @@ modparam("dialog", "timer_procs", 1) </example> </section> + <section id="dialog.p.track_cseq_updates"> + <title><varname>track_cseq_updates</varname> (int)</title> + <para> + Enable the callbacks for tracking if CSeq number needs to + be updated. It is the case when the INVITE has to be + authenticated to downstream provider using uac_auth() from + uac module. + </para> + <para> + This is done only for requests in downstream direction. The + CSeq difference is stored in $dlg_var(cseq_diff), be sure + this variable is not overwritten via config operation. + </para> + <para> + <emphasis> + Default value is <quote>0</quote> (disabled). + </emphasis> + </para> + <example> + <title>Set <varname>track_cseq_updates</varname> parameter</title> + <programlisting format="linespecific"> +... +modparam("dialog", "track_cseq_updates", 1) +... +</programlisting> + </example> + </section> + </section>