From 9762c5f0d8268e76d55030203b5f0021509fffe6 Mon Sep 17 00:00:00 2001 From: Kamailio Dev Date: Wed, 16 Nov 2022 16:46:25 +0100 Subject: [PATCH] modules: readme files regenerated - dialog ... [skip ci] --- src/modules/dialog/README | 113 ++++++++++++++++++++++---------------- 1 file changed, 65 insertions(+), 48 deletions(-) diff --git a/src/modules/dialog/README b/src/modules/dialog/README index 06e279ec4f4..e0cb70903d6 100644 --- a/src/modules/dialog/README +++ b/src/modules/dialog/README @@ -117,6 +117,7 @@ Julien Klingenmeyer 6.64. bye_early_code (int) 6.65. bye_early_reason (string) 6.66. dlg_ctxiuid_mode (int) + 6.67. debug_variables (int) 7. Functions @@ -266,30 +267,31 @@ Julien Klingenmeyer 1.64. Set bye_early_code parameter 1.65. Set bye_early_reason parameter 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 + 1.67. Set debug_variables parameter + 1.68. set_dlg_profile usage + 1.69. unset_dlg_profile usage + 1.70. is_in_profile usage + 1.71. get_profile_size usage + 1.72. dlg_isflagset usage + 1.73. dlg_setflag usage + 1.74. dlg_resetflag usage + 1.75. dlg_bye usage + 1.76. dlg_refer usage + 1.77. dlg_manage usage + 1.78. dlg_bridge usage + 1.79. dlg_get usage + 1.80. dlg_get_var usage + 1.81. dlg_set_var usage + 1.82. is_known_dlg() usage + 1.83. dlg_set_timeout usage + 1.84. dlg_set_timeout_by_profile usage + 1.85. dlg_set_property usage + 1.86. dlg_remote_profile usage + 1.87. dlg_set_ruri() usage + 1.88. dlg_db_load_callid() usage + 1.89. dlg_db_load_extra() usage + 1.90. dlg_reset_property usage + 1.91. dlg_req_within usage Chapter 1. Admin Guide @@ -372,6 +374,7 @@ Chapter 1. Admin Guide 6.64. bye_early_code (int) 6.65. bye_early_reason (string) 6.66. dlg_ctxiuid_mode (int) + 6.67. debug_variables (int) 7. Functions @@ -611,6 +614,7 @@ Chapter 1. Admin Guide 6.64. bye_early_code (int) 6.65. bye_early_reason (string) 6.66. dlg_ctxiuid_mode (int) + 6.67. debug_variables (int) 6.1. enable_stats (integer) @@ -1513,6 +1517,19 @@ modparam("dialog", "bye_early_reason", "Call terminated") modparam("dialog", "dlg_ctxiuid_mode", 1) ... +6.67. debug_variables (int) + + Activate additional debugging for printing internal lists for dialog + variables. This output is only visible at debug log level and should + only be used for debugging. By default its deactivated. + + Default value is “0”. + + Example 1.67. Set debug_variables parameter +... +modparam("dialog", "debug_variables", 1) +... + 7. Functions 7.1. set_dlg_profile(profile,[value]) @@ -1556,7 +1573,7 @@ modparam("dialog", "dlg_ctxiuid_mode", 1) This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE and FAILURE_ROUTE. - Example 1.67. set_dlg_profile usage + Example 1.68. set_dlg_profile usage ... set_dlg_profile("inbound_call"); set_dlg_profile("caller","$fu"); @@ -1575,7 +1592,7 @@ set_dlg_profile("caller","$fu"); This function can be used from BRANCH_ROUTE, REPLY_ROUTE and FAILURE_ROUTE. - Example 1.68. unset_dlg_profile usage + Example 1.69. unset_dlg_profile usage ... unset_dlg_profile("inbound_call"); unset_dlg_profile("caller","$fu"); @@ -1598,7 +1615,7 @@ unset_dlg_profile("caller","$fu"); This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE and FAILURE_ROUTE. - Example 1.69. is_in_profile usage + Example 1.70. is_in_profile usage ... if (is_in_profile("inbound_call")) { log("this request belongs to a inbound call\n"); @@ -1628,7 +1645,7 @@ if (is_in_profile("caller","XX")) { This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE and FAILURE_ROUTE. - Example 1.70. get_profile_size usage + Example 1.71. get_profile_size usage ... if(get_profile_size("inbound_call","$avp(size)")) xlog("currently there are $avp(size) inbound calls\n"); @@ -1647,7 +1664,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.71. dlg_isflagset usage + Example 1.72. dlg_isflagset usage ... if(dlg_isflagset("1")) { @@ -1665,7 +1682,7 @@ if(dlg_isflagset("1")) This function can be used from BRANCH_ROUTE, REQUEST_ROUTE, ONREPLY_ROUTE and FAILURE_ROUTE. - Example 1.72. dlg_setflag usage + Example 1.73. dlg_setflag usage ... dlg_setflag("1"); ... @@ -1680,7 +1697,7 @@ dlg_setflag("1"); This function can be used from BRANCH_ROUTE, REQUEST_ROUTE, ONREPLY_ROUTE and FAILURE_ROUTE. - Example 1.73. dlg_resetflag usage + Example 1.74. dlg_resetflag usage ... redlg_setflag("1"); ... @@ -1697,7 +1714,7 @@ redlg_setflag("1"); This function can be used from ANY_ROUTE. - Example 1.74. dlg_bye usage + Example 1.75. dlg_bye usage ... dlg_bye("all"); ... @@ -1714,7 +1731,7 @@ dlg_bye("all"); This function can be used from BRANCH_ROUTE, REQUEST_ROUTE, ONREPLY_ROUTE and FAILURE_ROUTE. - Example 1.75. dlg_refer usage + Example 1.76. dlg_refer usage ... dlg_refer("caller", "sip:announcement@kamailio.org"); ... @@ -1727,7 +1744,7 @@ dlg_refer("caller", "sip:announcement@kamailio.org"); This function can be used from REQUEST_ROUTE. - Example 1.76. dlg_manage usage + Example 1.77. dlg_manage usage ... modparam("dialog", "default_timeout", 100) ... @@ -1755,7 +1772,7 @@ request_route { This function can be used from BRANCH_ROUTE, REQUEST_ROUTE, ONREPLY_ROUTE and FAILURE_ROUTE. - Example 1.77. dlg_bridge usage + Example 1.78. dlg_bridge usage ... dlg_bridge("sip:user@kamailio.org", "sip:annoucement@kamailio.org", "sip:kamailio.org:5080"); @@ -1775,7 +1792,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.78. dlg_get usage + Example 1.79. dlg_get usage ... if(dlg_get("abcdef", "123", "456")) { @@ -1798,7 +1815,7 @@ if(dlg_get("abcdef", "123", "456")) This function can be used from BRANCH_ROUTE, REQUEST_ROUTE, ONREPLY_ROUTE and FAILURE_ROUTE. - Example 1.79. dlg_get_var usage + Example 1.80. dlg_get_var usage ... if(dlg_get_var("$var(ci)", "$var(ft)", "456", "test", "$var(tmp)")) { @@ -1821,7 +1838,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.80. dlg_set_var usage + Example 1.81. dlg_set_var usage ... if(dlg_set_var("$var(ci)", "$var(ft)", "456", "test", "$var(tmp)")) { @@ -1850,7 +1867,7 @@ if(dlg_set_var("$var(ci)", "$var(ft)", "", "test", "$var(tmp)")) This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE and FAILURE_ROUTE. - Example 1.81. is_known_dlg() usage + Example 1.82. is_known_dlg() usage ... if(!uri == myself) { if(is_known_dlg()) { @@ -1874,7 +1891,7 @@ if(!uri == myself) { This function can be used from ANY_ROUTE. - Example 1.82. dlg_set_timeout usage + Example 1.83. dlg_set_timeout usage ... if(dlg_set_timeout("180", "123", "456")) { @@ -1896,7 +1913,7 @@ if(dlg_set_timeout("180", "123", "456")) This function can be used from ANY_ROUTE. - Example 1.83. dlg_set_timeout_by_profile usage + Example 1.84. dlg_set_timeout_by_profile usage ... # All dialogs belonging to user abc123 (tracked via set_dlg_profile()) # will be timed out in 3 seconds. @@ -1928,7 +1945,7 @@ dlg_set_timeout_by_profile("users", "abc123", "3"); This function can be used from ANY_ROUTE. - Example 1.84. dlg_set_property usage + Example 1.85. dlg_set_property usage ... dlg_set_property("ka-src"); dlg_set_property("ka-dst"); @@ -1956,7 +1973,7 @@ dlg_set_property("timeout-noreset"); This function can be used from ANY_ROUTE. - Example 1.85. dlg_remote_profile usage + Example 1.86. dlg_remote_profile usage ... $var(exp) = 3600 + $Ts; dlg_remote_profile("add", "caller", "test", "$sruid", "$var(exp)"); @@ -1969,7 +1986,7 @@ dlg_remote_profile("add", "caller", "test", "$sruid", "$var(exp)"); This function can be used from ANY_ROUTE. - Example 1.86. dlg_set_ruri() usage + Example 1.87. dlg_set_ruri() usage ... if(has_totag() and is_present_hf("Route") and uri==myself ) { if(dlg_set_ruri()) { @@ -1985,7 +2002,7 @@ if(has_totag() and is_present_hf("Route") and uri==myself ) { This function can be used from ANY_ROUTE. - Example 1.87. dlg_db_load_callid() usage + Example 1.88. dlg_db_load_callid() usage ... if(has_totag()) { if(!is_known_dlg()) { @@ -2004,7 +2021,7 @@ if(has_totag()) { This function can be used from ANY_ROUTE. - Example 1.88. dlg_db_load_extra() usage + Example 1.89. dlg_db_load_extra() usage ... if(has_totag()) { if(!is_known_dlg()) { @@ -2030,7 +2047,7 @@ if(has_totag()) { This function can be used from ANY_ROUTE. - Example 1.89. dlg_reset_property usage + Example 1.90. dlg_reset_property usage ... dlg_reset_property("ka-src"); dlg_reset_property("ka-dst"); @@ -2053,7 +2070,7 @@ dlg_reset_property("timeout-noreset"); This function can be used from ANY_ROUTE. - Example 1.90. dlg_req_within usage + Example 1.91. dlg_req_within usage ... # Send a simple request: dlg_req_within("all", "OPTIONS");