From 8bdc40e085edddf1e58d8946e06983707fb15770 Mon Sep 17 00:00:00 2001 From: Kamailio Dev Date: Mon, 14 Aug 2023 17:16:24 +0200 Subject: [PATCH] modules: readme files regenerated - dispatcher ... [skip ci] --- src/modules/dispatcher/README | 275 ++++++++++++++++++---------------- src/modules/ims_qos/README | 6 +- 2 files changed, 151 insertions(+), 130 deletions(-) diff --git a/src/modules/dispatcher/README b/src/modules/dispatcher/README index 249533a030e..307217bf070 100644 --- a/src/modules/dispatcher/README +++ b/src/modules/dispatcher/README @@ -85,23 +85,24 @@ Federico Cabiddu 3.24. ds_ping_reply_codes (string) 3.25. ds_probing_mode (int) 3.26. ds_ping_latency_stats (int) - 3.27. ds_latency_estimator_alpha (int) - 3.28. ds_hash_size (int) - 3.29. ds_hash_expire (int) - 3.30. ds_hash_initexpire (int) - 3.31. ds_hash_check_interval (int) - 3.32. outbound_proxy (str) - 3.33. ds_default_socket (str) - 3.34. ds_default_sockname (str) - 3.35. ds_timer_mode (int) - 3.36. event_callback (str) - 3.37. ds_attrs_none (int) - 3.38. ds_db_extra_attrs (str) - 3.39. ds_load_mode (int) - 3.40. reload_delta (int) - 3.41. ds_dns_mode (int) - 3.42. ds_dns_interval (int) - 3.43. ds_dns_ttl (int) + 3.27. ds_retain_latency_stats (int) + 3.28. ds_latency_estimator_alpha (int) + 3.29. ds_hash_size (int) + 3.30. ds_hash_expire (int) + 3.31. ds_hash_initexpire (int) + 3.32. ds_hash_check_interval (int) + 3.33. outbound_proxy (str) + 3.34. ds_default_socket (str) + 3.35. ds_default_sockname (str) + 3.36. ds_timer_mode (int) + 3.37. event_callback (str) + 3.38. ds_attrs_none (int) + 3.39. ds_db_extra_attrs (str) + 3.40. ds_load_mode (int) + 3.41. reload_delta (int) + 3.42. ds_dns_mode (int) + 3.43. ds_dns_interval (int) + 3.44. ds_dns_ttl (int) 4. Functions @@ -178,36 +179,37 @@ Federico Cabiddu 1.26. Set the “ds_probing_mode” parameter 1.27. accessing the metrics 1.28. Set the “ds_ping_latency_stats” parameter - 1.29. Set the “ds_latency_estimator_alpha” parameter - 1.30. Set the “ds_hash_size” parameter - 1.31. Set the “ds_hash_expire” parameter - 1.32. Set the “ds_hash_initexpire” parameter - 1.33. Set the “ds_hash_check_interval” parameter - 1.34. Set the “outbound_proxy” parameter - 1.35. Set the “ds_default_socket” parameter - 1.36. Set the “ds_default_sockname” parameter - 1.37. Set the “ds_timer_mode” parameter - 1.38. Set event_callback parameter - 1.39. Set the “ds_attrs_none” parameter - 1.40. Set the “ds_db_extra_attrs” parameter - 1.41. Set the “ds_load_mode” parameter - 1.42. Set reload_delta parameter - 1.43. Set the “ds_dns_mode” parameter - 1.44. Set the “ds_dns_interval” parameter - 1.45. Set the “ds_dns_ttl” parameter - 1.46. latency_optimized_dispatching usage - 1.47. ds_select_dst usage - 1.48. configuring load balancing with congestion detection - 1.49. ds_select_domain usage - 1.50. ds_select usage - 1.51. ds_select_routes usage - 1.52. ds_mark_dst usage - 1.53. ds_list_exists usage - 1.54. ds_is_from_list usage - 1.55. ds_is_active usage - 1.56. ds_load_unset usage - 1.57. dispatcher list file - 1.58. Kamailio config script - sample dispatcher usage + 1.29. Set the “ds_retain_latency_stats” parameter + 1.30. Set the “ds_latency_estimator_alpha” parameter + 1.31. Set the “ds_hash_size” parameter + 1.32. Set the “ds_hash_expire” parameter + 1.33. Set the “ds_hash_initexpire” parameter + 1.34. Set the “ds_hash_check_interval” parameter + 1.35. Set the “outbound_proxy” parameter + 1.36. Set the “ds_default_socket” parameter + 1.37. Set the “ds_default_sockname” parameter + 1.38. Set the “ds_timer_mode” parameter + 1.39. Set event_callback parameter + 1.40. Set the “ds_attrs_none” parameter + 1.41. Set the “ds_db_extra_attrs” parameter + 1.42. Set the “ds_load_mode” parameter + 1.43. Set reload_delta parameter + 1.44. Set the “ds_dns_mode” parameter + 1.45. Set the “ds_dns_interval” parameter + 1.46. Set the “ds_dns_ttl” parameter + 1.47. latency_optimized_dispatching usage + 1.48. ds_select_dst usage + 1.49. configuring load balancing with congestion detection + 1.50. ds_select_domain usage + 1.51. ds_select usage + 1.52. ds_select_routes usage + 1.53. ds_mark_dst usage + 1.54. ds_list_exists usage + 1.55. ds_is_from_list usage + 1.56. ds_is_active usage + 1.57. ds_load_unset usage + 1.58. dispatcher list file + 1.59. Kamailio config script - sample dispatcher usage Chapter 1. Admin Guide @@ -247,23 +249,24 @@ Chapter 1. Admin Guide 3.24. ds_ping_reply_codes (string) 3.25. ds_probing_mode (int) 3.26. ds_ping_latency_stats (int) - 3.27. ds_latency_estimator_alpha (int) - 3.28. ds_hash_size (int) - 3.29. ds_hash_expire (int) - 3.30. ds_hash_initexpire (int) - 3.31. ds_hash_check_interval (int) - 3.32. outbound_proxy (str) - 3.33. ds_default_socket (str) - 3.34. ds_default_sockname (str) - 3.35. ds_timer_mode (int) - 3.36. event_callback (str) - 3.37. ds_attrs_none (int) - 3.38. ds_db_extra_attrs (str) - 3.39. ds_load_mode (int) - 3.40. reload_delta (int) - 3.41. ds_dns_mode (int) - 3.42. ds_dns_interval (int) - 3.43. ds_dns_ttl (int) + 3.27. ds_retain_latency_stats (int) + 3.28. ds_latency_estimator_alpha (int) + 3.29. ds_hash_size (int) + 3.30. ds_hash_expire (int) + 3.31. ds_hash_initexpire (int) + 3.32. ds_hash_check_interval (int) + 3.33. outbound_proxy (str) + 3.34. ds_default_socket (str) + 3.35. ds_default_sockname (str) + 3.36. ds_timer_mode (int) + 3.37. event_callback (str) + 3.38. ds_attrs_none (int) + 3.39. ds_db_extra_attrs (str) + 3.40. ds_load_mode (int) + 3.41. reload_delta (int) + 3.42. ds_dns_mode (int) + 3.43. ds_dns_interval (int) + 3.44. ds_dns_ttl (int) 4. Functions @@ -371,23 +374,24 @@ Chapter 1. Admin Guide 3.24. ds_ping_reply_codes (string) 3.25. ds_probing_mode (int) 3.26. ds_ping_latency_stats (int) - 3.27. ds_latency_estimator_alpha (int) - 3.28. ds_hash_size (int) - 3.29. ds_hash_expire (int) - 3.30. ds_hash_initexpire (int) - 3.31. ds_hash_check_interval (int) - 3.32. outbound_proxy (str) - 3.33. ds_default_socket (str) - 3.34. ds_default_sockname (str) - 3.35. ds_timer_mode (int) - 3.36. event_callback (str) - 3.37. ds_attrs_none (int) - 3.38. ds_db_extra_attrs (str) - 3.39. ds_load_mode (int) - 3.40. reload_delta (int) - 3.41. ds_dns_mode (int) - 3.42. ds_dns_interval (int) - 3.43. ds_dns_ttl (int) + 3.27. ds_retain_latency_stats (int) + 3.28. ds_latency_estimator_alpha (int) + 3.29. ds_hash_size (int) + 3.30. ds_hash_expire (int) + 3.31. ds_hash_initexpire (int) + 3.32. ds_hash_check_interval (int) + 3.33. outbound_proxy (str) + 3.34. ds_default_socket (str) + 3.35. ds_default_sockname (str) + 3.36. ds_timer_mode (int) + 3.37. event_callback (str) + 3.38. ds_attrs_none (int) + 3.39. ds_db_extra_attrs (str) + 3.40. ds_load_mode (int) + 3.41. reload_delta (int) + 3.42. ds_dns_mode (int) + 3.43. ds_dns_interval (int) + 3.44. ds_dns_ttl (int) 3.1. list_file (string) @@ -813,7 +817,22 @@ estimator_alpha modparam("dispatcher", "ds_ping_latency_stats", 1) ... -3.27. ds_latency_estimator_alpha (int) +3.27. ds_retain_latency_stats (int) + + Retain latency stats for existing destinations when reloading from file + or database. + * If set to 0, stats for all destinations will be reset on reload. + * If set to 1, stats for existing destinations will persist across + reloads. + + Default value is “0”. + + Example 1.29. Set the “ds_retain_latency_stats” parameter +... +modparam("dispatcher", "ds_retain_latency_stats", 1) +... + +3.28. ds_latency_estimator_alpha (int) The value to be used to control the memory of the estimator EWMA "exponential weighted moving average" or "the speed at which the older @@ -825,12 +844,12 @@ modparam("dispatcher", "ds_ping_latency_stats", 1) Default value is “900 => 0.9”. - Example 1.29. Set the “ds_latency_estimator_alpha” parameter + Example 1.30. Set the “ds_latency_estimator_alpha” parameter ... modparam("dispatcher", "ds_latency_estimator_alpha", 900) ... -3.28. ds_hash_size (int) +3.29. ds_hash_size (int) The value to be used as power of two to set the number of slots to hash table storing data for call load dispatching (e.g., value 8 will create @@ -839,24 +858,24 @@ modparam("dispatcher", "ds_latency_estimator_alpha", 900) Default value is “0”. - Example 1.30. Set the “ds_hash_size” parameter + Example 1.31. Set the “ds_hash_size” parameter ... modparam("dispatcher", "ds_hash_size", 9) ... -3.29. ds_hash_expire (int) +3.30. ds_hash_expire (int) Expiration time in seconds to remove the load on a destination if no BYE was received meanwhile. Default value is “7200”. - Example 1.31. Set the “ds_hash_expire” parameter + Example 1.32. Set the “ds_hash_expire” parameter ... modparam("dispatcher", "ds_hash_expire", 3600) ... -3.30. ds_hash_initexpire (int) +3.31. ds_hash_initexpire (int) Expiration time in seconds to remove the load on a destination if no 200 for INVITE was received meanwhile and state updated with @@ -864,35 +883,35 @@ modparam("dispatcher", "ds_hash_expire", 3600) Default value is “7200”. - Example 1.32. Set the “ds_hash_initexpire” parameter + Example 1.33. Set the “ds_hash_initexpire” parameter ... modparam("dispatcher", "ds_hash_initexpire", 60) ... -3.31. ds_hash_check_interval (int) +3.32. ds_hash_check_interval (int) Time interval in seconds to scan internal hash table with call load dispatching data for expired items. Default value is “30”. - Example 1.33. Set the “ds_hash_check_interval” parameter + Example 1.34. Set the “ds_hash_check_interval” parameter ... modparam("dispatcher", "ds_hash_check_interval", 60) ... -3.32. outbound_proxy (str) +3.33. outbound_proxy (str) SIP URI of outbound proxy to be used when sending pings. By default no outbound proxy is defined. - Example 1.34. Set the “outbound_proxy” parameter + Example 1.35. Set the “outbound_proxy” parameter ... modparam("dispatcher", "outbound_proxy", "sip:outbound.example.com") ... -3.33. ds_default_socket (str) +3.34. ds_default_socket (str) Default socket to be used for sending pings and dispatching requests when a gateway has no send socket configured. @@ -903,12 +922,12 @@ modparam("dispatcher", "outbound_proxy", "sip:outbound.example.com") If parameter "ds_default_sockname" is set, then this parameter is ignored. - Example 1.35. Set the “ds_default_socket” parameter + Example 1.36. Set the “ds_default_socket” parameter ... modparam("dispatcher", "ds_default_socket", "udp:192.168.0.125:5060") ... -3.34. ds_default_sockname (str) +3.35. ds_default_sockname (str) Default socket name to be used for sending pings and dispatching requests when a gateway has no send socket configured. @@ -919,14 +938,14 @@ modparam("dispatcher", "ds_default_socket", "udp:192.168.0.125:5060") This parameter is used even if "ds_default_socket" parameter is set (this parameter has higher priority). - Example 1.36. Set the “ds_default_sockname” parameter + Example 1.37. Set the “ds_default_sockname” parameter ... listen=udp:1.2.3.4:5060 name "sock1" ... modparam("dispatcher", "ds_default_sockname", "sock1") ... -3.35. ds_timer_mode (int) +3.36. ds_timer_mode (int) Specify the timer process to be used by the module for keepalives and active dialogs tracking. @@ -941,12 +960,12 @@ modparam("dispatcher", "ds_default_sockname", "sock1") Default value is “0”. - Example 1.37. Set the “ds_timer_mode” parameter + Example 1.38. Set the “ds_timer_mode” parameter ... modparam("dispatcher", "ds_timer_mode", 1) ... -3.36. event_callback (str) +3.37. event_callback (str) The name of the function in the kemi configuration file (embedded scripting language such as Lua, Python, ...) to be executed instead of @@ -957,7 +976,7 @@ modparam("dispatcher", "ds_timer_mode", 1) Default value is 'empty' (no function is executed for events). - Example 1.38. Set event_callback parameter + Example 1.39. Set event_callback parameter ... modparam("dispatcher", "event_callback", "ksr_dispatcher_event") ... @@ -968,7 +987,7 @@ function ksr_dispatcher_event(evname) end ... -3.37. ds_attrs_none (int) +3.38. ds_attrs_none (int) If set to 1, "none=yes" is set in the attrs for those records that have no attrs value, to ensure that corresponding XAVP fields for records do @@ -976,12 +995,12 @@ end Default value is “0”. - Example 1.39. Set the “ds_attrs_none” parameter + Example 1.40. Set the “ds_attrs_none” parameter ... modparam("dispatcher", "ds_attrs_none", 1) ... -3.38. ds_db_extra_attrs (str) +3.39. ds_db_extra_attrs (str) Set a list of column names to be loaded from database dispatcher table and be concatenated to 'attrs' field. The format is: @@ -993,12 +1012,12 @@ modparam("dispatcher", "ds_attrs_none", 1) Default value is “empty”. - Example 1.40. Set the “ds_db_extra_attrs” parameter + Example 1.41. Set the “ds_db_extra_attrs” parameter ... modparam("dispatcher", "ds_db_extra_attrs", "socket=socket;pref=prefix") ... -3.39. ds_load_mode (int) +3.40. ds_load_mode (int) If set to 1, the module throws error when failing to add a destination address (e.g., invalid URI). If set to 0, it skips the failing address @@ -1006,12 +1025,12 @@ modparam("dispatcher", "ds_db_extra_attrs", "socket=socket;pref=prefix") Default value is “0”. - Example 1.41. Set the “ds_load_mode” parameter + Example 1.42. Set the “ds_load_mode” parameter ... modparam("dispatcher", "ds_load_mode", 1) ... -3.40. reload_delta (int) +3.41. reload_delta (int) The number of seconds that have to be waited before executing a new reload of dispatcher records. By default there is a rate limiting of @@ -1023,12 +1042,12 @@ modparam("dispatcher", "ds_load_mode", 1) Default value is “5”. - Example 1.42. Set reload_delta parameter + Example 1.43. Set reload_delta parameter ... modparam("dispatcher", "reload_delta", 1) ... -3.41. ds_dns_mode (int) +3.42. ds_dns_mode (int) Specify the how DNS resolving is done for destination addresses. @@ -1044,24 +1063,24 @@ modparam("dispatcher", "reload_delta", 1) Default value is “1”. - Example 1.43. Set the “ds_dns_mode” parameter + Example 1.44. Set the “ds_dns_mode” parameter ... modparam("dispatcher", "ds_dns_mode", 2) ... -3.42. ds_dns_interval (int) +3.43. ds_dns_interval (int) The interval in seconds to periodically refresh the DNS queries for destination addresses if ds_dns_mode has value 4 set. Default value is “600”. - Example 1.44. Set the “ds_dns_interval” parameter + Example 1.45. Set the “ds_dns_interval” parameter ... modparam("dispatcher", "ds_interval_mode", 1800) ... -3.43. ds_dns_ttl (int) +3.44. ds_dns_ttl (int) The interval in seconds to set TTL for DNS results received for queries dones inside this module. If 0, this TTL is not set, result and core @@ -1069,7 +1088,7 @@ modparam("dispatcher", "ds_interval_mode", 1800) Default value is “0”. - Example 1.45. Set the “ds_dns_ttl” parameter + Example 1.46. Set the “ds_dns_ttl” parameter ... modparam("dispatcher", "ds_interval_mode", 7200) ... @@ -1185,7 +1204,7 @@ modparam("dispatcher", "ds_interval_mode", 7200) - If the attribute 'cc=1' is set, the latency used is congestion ms : estimate (current latency ms) - average (normal condition latency ms). - Example 1.46. latency_optimized_dispatching usage + Example 1.47. latency_optimized_dispatching usage Using this simple formula : ADJUSTED_PRIORITY = PRIORITY - (ESTIMATED_LATENCY_MS/PRIORITY) @@ -1213,7 +1232,7 @@ With congestion control the formula becomes : This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. - Example 1.47. ds_select_dst usage + Example 1.48. ds_select_dst usage ... ds_select_dst("1", "0"); ... @@ -1223,7 +1242,7 @@ ds_select_dst("1", "$var(a)"); ds_select_dst("1", "4", "3"); ... - Example 1.48. configuring load balancing with congestion detection + Example 1.49. configuring load balancing with congestion detection ... # sample of SQL provisioning statements INSERT INTO "dispatcher" @@ -1277,7 +1296,7 @@ DEST: { This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. - Example 1.49. ds_select_domain usage + Example 1.50. ds_select_domain usage ... $var(a) = 4; if(ds_select_domain("1", "$var(a)")) { @@ -1301,7 +1320,7 @@ if(ds_select_domain("1", "$var(a)")) { This function can be used from ANY_ROUTE. - Example 1.50. ds_select usage + Example 1.51. ds_select usage ... $var(a) = 4; if(ds_select("1", "$var(a)")) { @@ -1344,7 +1363,7 @@ if(ds_select("1", "$var(a)")) { This function can be used from ANY_ROUTE. - Example 1.51. ds_select_routes usage + Example 1.52. ds_select_routes usage ... $var(alg) = 4; $var(limit) = 8; @@ -1419,7 +1438,7 @@ failure_route[REROUTE] { This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. - Example 1.52. ds_mark_dst usage + Example 1.53. ds_mark_dst usage ... failure_route[tryagain] { ... @@ -1441,7 +1460,7 @@ failure_route[tryagain] { This function can be used from ANY_ROUTE. - Example 1.53. ds_list_exists usage + Example 1.54. ds_list_exists usage ... if(ds_list_exists("10")) { ... @@ -1486,7 +1505,7 @@ if(ds_list_exists("10")) { This function can be used from ANY_ROUTE. - Example 1.54. ds_is_from_list usage + Example 1.55. ds_is_from_list usage ... if(ds_is_from_list()) { ... @@ -1516,7 +1535,7 @@ if(ds_is_from_list("10", "3", "sip:127.0.0.1:5080")) { This function can be used from ANY_ROUTE. - Example 1.55. ds_is_active usage + Example 1.56. ds_is_active usage ... if(ds_is_active("10")) { ... @@ -1544,7 +1563,7 @@ if(ds_is_active("10", "sip:127.0.0.1:5080")) { This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE and ONREPLY_ROUTE. - Example 1.56. ds_load_unset usage + Example 1.57. ds_load_unset usage ... route { ... @@ -1856,7 +1875,7 @@ setid(int) destination(sip uri) flags(int,opt) priority(int,opt) attrs(str,opt) For database, each element of a line resides in a different column. Next is a dispatcher.list file example: - Example 1.57. dispatcher list file + Example 1.58. dispatcher list file ... # # dispatcher destination sets (groups) @@ -1881,7 +1900,7 @@ r,opt) Next listing shows a sample config for using the dispatcher module. - Example 1.58. Kamailio config script - sample dispatcher usage + Example 1.59. Kamailio config script - sample dispatcher usage ... #!KAMAILIO # diff --git a/src/modules/ims_qos/README b/src/modules/ims_qos/README index 990934a6ac0..e9c150274eb 100644 --- a/src/modules/ims_qos/README +++ b/src/modules/ims_qos/README @@ -167,7 +167,7 @@ Chapter 1. Admin Guide 2.1. Kamailio Modules The Following modules must be loaded before this module: - * Dialog + * IMS Dialog * Usrloc PCSCF * TM - Transaction Manager * CDP - C Diameter Peer @@ -559,7 +559,9 @@ route[REG_AAR_REPLY] default. This is as per RFC 4006: END_USER_E164 0, END_USER_IMSI 1, END_USER_SIP_URI 2, END_USER_NAI 3, END_USER_PRIVATE 4 - This function can be used from REQUEST_ROUTE or ONREPLY_ROUTE. + This function can be used only from ONREPLY_ROUTE, only for replies to + INVITE, UPDATE, PRACK. The reply and request must have SDP, for this + function to work properly. p.s. this is executed asynchronously. See example on how to retrieve return value