modules: readme files regenerated - dialog ... [skip ci]

src/modules/dialog/README

@@ -116,6 +116,7 @@ Julien Klingenmeyer
               6.63. keep_proxy_rr (string)
               6.64. bye_early_code (int)
               6.65. bye_early_reason (string)
+              6.66. dlg_ctxiuid_mode (int)
 
         7. Functions
 
@@ -264,30 +265,31 @@ Julien Klingenmeyer
    1.63. Set dlg_keep_proxy_rr parameter
    1.64. Set bye_early_code parameter
    1.65. Set bye_early_reason parameter
-   1.66. set_dlg_profile usage
-   1.67. unset_dlg_profile usage
-   1.68. is_in_profile usage
-   1.69. get_profile_size usage
-   1.70. dlg_isflagset usage
-   1.71. dlg_setflag usage
-   1.72. dlg_resetflag usage
-   1.73. dlg_bye usage
-   1.74. dlg_refer usage
-   1.75. dlg_manage usage
-   1.76. dlg_bridge usage
-   1.77. dlg_get usage
-   1.78. dlg_get_var usage
-   1.79. dlg_set_var usage
-   1.80. is_known_dlg() usage
-   1.81. dlg_set_timeout usage
-   1.82. dlg_set_timeout_by_profile usage
-   1.83. dlg_set_property usage
-   1.84. dlg_remote_profile usage
-   1.85. dlg_set_ruri() usage
-   1.86. dlg_db_load_callid() usage
-   1.87. dlg_db_load_extra() usage
-   1.88. dlg_reset_property usage
-   1.89. dlg_req_within usage
+   1.66. Set dlg_ctxiuid_mode parameter
+   1.67. set_dlg_profile usage
+   1.68. unset_dlg_profile usage
+   1.69. is_in_profile usage
+   1.70. get_profile_size usage
+   1.71. dlg_isflagset usage
+   1.72. dlg_setflag usage
+   1.73. dlg_resetflag usage
+   1.74. dlg_bye usage
+   1.75. dlg_refer usage
+   1.76. dlg_manage usage
+   1.77. dlg_bridge usage
+   1.78. dlg_get usage
+   1.79. dlg_get_var usage
+   1.80. dlg_set_var usage
+   1.81. is_known_dlg() usage
+   1.82. dlg_set_timeout usage
+   1.83. dlg_set_timeout_by_profile usage
+   1.84. dlg_set_property usage
+   1.85. dlg_remote_profile usage
+   1.86. dlg_set_ruri() usage
+   1.87. dlg_db_load_callid() usage
+   1.88. dlg_db_load_extra() usage
+   1.89. dlg_reset_property usage
+   1.90. dlg_req_within usage
 
 Chapter 1. Admin Guide
 
@@ -369,6 +371,7 @@ Chapter 1. Admin Guide
         6.63. keep_proxy_rr (string)
         6.64. bye_early_code (int)
         6.65. bye_early_reason (string)
+        6.66. dlg_ctxiuid_mode (int)
 
    7. Functions
 
@@ -607,6 +610,7 @@ Chapter 1. Admin Guide
    6.63. keep_proxy_rr (string)
    6.64. bye_early_code (int)
    6.65. bye_early_reason (string)
+   6.66. dlg_ctxiuid_mode (int)
 
 6.1. enable_stats (integer)
 
@@ -1496,6 +1500,19 @@ modparam("dialog", "bye_early_code", 503)
 modparam("dialog", "bye_early_reason", "Call terminated")
 ...
 
+6.66. dlg_ctxiuid_mode (int)
+
+   Set dialog context iuid mode, which can specify additional cases when
+   the internal unique id should be set:
+     * 1 - set it when processing CANCEL requests.
+
+   Default value is “0”.
+
+   Example 1.66. Set dlg_ctxiuid_mode parameter
+...
+modparam("dialog", "dlg_ctxiuid_mode", 1)
+...
+
 7. Functions
 
    7.1. set_dlg_profile(profile,[value])
@@ -1539,7 +1556,7 @@ modparam("dialog", "bye_early_reason", "Call terminated")
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
    and FAILURE_ROUTE.
 
-   Example 1.66. set_dlg_profile usage
+   Example 1.67. set_dlg_profile usage
 ...
 set_dlg_profile("inbound_call");
 set_dlg_profile("caller","$fu");
@@ -1558,7 +1575,7 @@ set_dlg_profile("caller","$fu");
    This function can be used from BRANCH_ROUTE, REPLY_ROUTE and
    FAILURE_ROUTE.
 
-   Example 1.67. unset_dlg_profile usage
+   Example 1.68. unset_dlg_profile usage
 ...
 unset_dlg_profile("inbound_call");
 unset_dlg_profile("caller","$fu");
@@ -1581,7 +1598,7 @@ unset_dlg_profile("caller","$fu");
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
    and FAILURE_ROUTE.
 
-   Example 1.68. is_in_profile usage
+   Example 1.69. is_in_profile usage
 ...
 if (is_in_profile("inbound_call")) {
         log("this request belongs to a inbound call\n");
@@ -1611,7 +1628,7 @@ if (is_in_profile("caller","XX")) {
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
    and FAILURE_ROUTE.
 
-   Example 1.69. get_profile_size usage
+   Example 1.70. get_profile_size usage
 ...
 if(get_profile_size("inbound_call","$avp(size)"))
     xlog("currently there are $avp(size) inbound calls\n");
@@ -1630,7 +1647,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.70. dlg_isflagset usage
+   Example 1.71. dlg_isflagset usage
 ...
 if(dlg_isflagset("1"))
 {
@@ -1648,7 +1665,7 @@ if(dlg_isflagset("1"))
    This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
    ONREPLY_ROUTE and FAILURE_ROUTE.
 
-   Example 1.71. dlg_setflag usage
+   Example 1.72. dlg_setflag usage
 ...
 dlg_setflag("1");
 ...
@@ -1663,7 +1680,7 @@ dlg_setflag("1");
    This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
    ONREPLY_ROUTE and FAILURE_ROUTE.
 
-   Example 1.72. dlg_resetflag usage
+   Example 1.73. dlg_resetflag usage
 ...
 redlg_setflag("1");
 ...
@@ -1680,7 +1697,7 @@ redlg_setflag("1");
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.73. dlg_bye usage
+   Example 1.74. dlg_bye usage
 ...
 dlg_bye("all");
 ...
@@ -1697,7 +1714,7 @@ dlg_bye("all");
    This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
    ONREPLY_ROUTE and FAILURE_ROUTE.
 
-   Example 1.74. dlg_refer usage
+   Example 1.75. dlg_refer usage
 ...
 dlg_refer("caller", "sip:[email protected]");
 ...
@@ -1710,7 +1727,7 @@ dlg_refer("caller", "sip:[email protected]");
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1.75. dlg_manage usage
+   Example 1.76. dlg_manage usage
 ...
 modparam("dialog", "default_timeout", 100)
 ...
@@ -1738,7 +1755,7 @@ request_route {
    This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
    ONREPLY_ROUTE and FAILURE_ROUTE.
 
-   Example 1.76. dlg_bridge usage
+   Example 1.77. dlg_bridge usage
 ...
 dlg_bridge("sip:[email protected]", "sip:[email protected]",
    "sip:kamailio.org:5080");
@@ -1758,7 +1775,7 @@ dlg_bridge("sip:[email protected]", "sip:[email protected]",
    This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
    ONREPLY_ROUTE and FAILURE_ROUTE.
 
-   Example 1.77. dlg_get usage
+   Example 1.78. dlg_get usage
 ...
 if(dlg_get("abcdef", "123", "456"))
 {
@@ -1781,7 +1798,7 @@ if(dlg_get("abcdef", "123", "456"))
    This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
    ONREPLY_ROUTE and FAILURE_ROUTE.
 
-   Example 1.78. dlg_get_var usage
+   Example 1.79. dlg_get_var usage
 ...
 if(dlg_get_var("$var(ci)", "$var(ft)", "456", "test", "$var(tmp)"))
 {
@@ -1804,7 +1821,7 @@ if(dlg_get_var("$var(ci)", "$var(ft)", "456", "test", "$var(tmp)"))
    This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
    ONREPLY_ROUTE and FAILURE_ROUTE.
 
-   Example 1.79. dlg_set_var usage
+   Example 1.80. dlg_set_var usage
 ...
 if(dlg_set_var("$var(ci)", "$var(ft)", "456", "test", "$var(tmp)"))
 {
@@ -1828,7 +1845,7 @@ if(dlg_set_var("$var(ci)", "$var(ft)", "456", "test", "$var(tmp)"))
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
    and FAILURE_ROUTE.
 
-   Example 1.80. is_known_dlg() usage
+   Example 1.81. is_known_dlg() usage
 ...
 if(!uri == myself) {
         if(is_known_dlg()) {
@@ -1852,7 +1869,7 @@ if(!uri == myself) {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.81. dlg_set_timeout usage
+   Example 1.82. dlg_set_timeout usage
 ...
 if(dlg_set_timeout("180", "123", "456"))
 {
@@ -1874,7 +1891,7 @@ if(dlg_set_timeout("180", "123", "456"))
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.82. dlg_set_timeout_by_profile usage
+   Example 1.83. dlg_set_timeout_by_profile usage
 ...
 # All dialogs belonging to user abc123 (tracked via set_dlg_profile())
 # will be timed out in 3 seconds.
@@ -1906,7 +1923,7 @@ dlg_set_timeout_by_profile("users", "abc123", "3");
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.83. dlg_set_property usage
+   Example 1.84. dlg_set_property usage
 ...
 dlg_set_property("ka-src");
 dlg_set_property("ka-dst");
@@ -1934,7 +1951,7 @@ dlg_set_property("timeout-noreset");
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.84. dlg_remote_profile usage
+   Example 1.85. dlg_remote_profile usage
 ...
 $var(exp) = 3600 + $Ts;
 dlg_remote_profile("add", "caller", "test", "$sruid", "$var(exp)");
@@ -1947,7 +1964,7 @@ dlg_remote_profile("add", "caller", "test", "$sruid", "$var(exp)");
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.85. dlg_set_ruri() usage
+   Example 1.86. dlg_set_ruri() usage
 ...
 if(has_totag() and is_present_hf("Route") and uri==myself ) {
         if(dlg_set_ruri()) {
@@ -1963,7 +1980,7 @@ if(has_totag() and is_present_hf("Route") and uri==myself ) {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.86. dlg_db_load_callid() usage
+   Example 1.87. dlg_db_load_callid() usage
 ...
 if(has_totag()) {
     if(!is_known_dlg()) {
@@ -1982,7 +1999,7 @@ if(has_totag()) {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.87. dlg_db_load_extra() usage
+   Example 1.88. dlg_db_load_extra() usage
 ...
 if(has_totag()) {
     if(!is_known_dlg()) {
@@ -2008,7 +2025,7 @@ if(has_totag()) {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.88. dlg_reset_property usage
+   Example 1.89. dlg_reset_property usage
 ...
 dlg_reset_property("ka-src");
 dlg_reset_property("ka-dst");
@@ -2031,7 +2048,7 @@ dlg_reset_property("timeout-noreset");
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.89. dlg_req_within usage
+   Example 1.90. dlg_req_within usage
 ...
         # Send a simple request:
         dlg_req_within("all", "OPTIONS");