[sr-dev] git:master:b4d38c4a: modules: readme files regenerated - usrloc ... [skip ci]

[Kamailio Dev]

Module: kamailio
Branch: master
Commit: b4d38c4a1bf40e190628a82db87a2b913abecf22
URL: https://github.com/kamailio/kamailio/commit/b4d38c4a1bf40e190628a82db87a2b913abecf22

Author: Kamailio Dev <kamailio.dev at kamailio.org>
Committer: Kamailio Dev <kamailio.dev at kamailio.org>
Date: 2020-03-27T10:31:18+01:00

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

---

Modified: src/modules/usrloc/README

---

Diff:  https://github.com/kamailio/kamailio/commit/b4d38c4a1bf40e190628a82db87a2b913abecf22.diff
Patch: https://github.com/kamailio/kamailio/commit/b4d38c4a1bf40e190628a82db87a2b913abecf22.patch

---

diff --git a/src/modules/usrloc/README b/src/modules/usrloc/README
index 2cc6ddc0f3..4637de5a55 100644
--- a/src/modules/usrloc/README
+++ b/src/modules/usrloc/README
@@ -89,6 +89,10 @@ Carsten Bock
               3.47. rm_expired_delay (int)
               3.48. server_id_filter (int)
               3.49. version_table (int)
+              3.50. ka_mode (int)
+              3.51. ka_method (str)
+              3.52. ka_from (str)
+              3.53. ka_domain (str)
 
         4. RPC Commands
 
@@ -185,6 +189,10 @@ Carsten Bock
    1.47. Set rm_expired_delay parameter
    1.48. Set server_id_filter parameter
    1.49. version_table parameter usage
+   1.50. ka_mode parameter usage
+   1.51. ka_method parameter usage
+   1.52. ka_from parameter usage
+   1.53. ka_domain parameter usage
 
 Chapter 1. Admin Guide
 
@@ -250,6 +258,10 @@ Chapter 1. Admin Guide
         3.47. rm_expired_delay (int)
         3.48. server_id_filter (int)
         3.49. version_table (int)
+        3.50. ka_mode (int)
+        3.51. ka_method (str)
+        3.52. ka_from (str)
+        3.53. ka_domain (str)
 
    4. RPC Commands
 
@@ -378,6 +390,10 @@ Chapter 1. Admin Guide
    3.47. rm_expired_delay (int)
    3.48. server_id_filter (int)
    3.49. version_table (int)
+   3.50. ka_mode (int)
+   3.51. ka_method (str)
+   3.52. ka_from (str)
+   3.53. ka_domain (str)
 
 3.1. nat_bflag (int)
 
@@ -1047,6 +1063,77 @@ modparam("usrloc", "server_id_filter", 1)
 modparam("usrloc", "version_table", 0)
 ...
 
+3.50. ka_mode (int)
+
+   Keepalive mode - control the internal keepalive mechanism. With this
+   feature enable, the module sends periodically (based on timer interval)
+   SIP requests to location contacts and measures the round trip in
+   microseconds (the round trip value can be seen in the response of the
+   RPC command 'ul.dump').
+
+   Its value is a set of flags:
+     * 0 - if the value is zero, no keepalive is sent
+     * 1 - if set to 1, the keepalive is enabled for all contacts
+     * 2 (bit 2 set) - the keepalive is sent only for natted contacts
+       (nat_bflag set)
+     * 4 (bit 3 set) - the keepalive is sent only for UDP contacts
+
+   For example, if set to 6, then keepalive is sent only natted UDP
+   contacs.
+
+   Note: the internal keepalive of usrloc module conflicts in some way
+   with the keepalive done by nathelper module. It is recommended to
+   enable only one.
+
+   Note: the internal keepalive is for the moment implemented only for
+   contact records stored in memory.
+
+   Note: it is recommeder to set 'timer_procs' parameter in order to have
+   dedicated timer processes for usrloc module and off-load the keepalive
+   sending process from the core timers.
+
+   Default value is “0 (keepalive disabled)”.
+
+   Example 1.50. ka_mode parameter usage
+...
+modparam("usrloc", "ka_mode", 1)
+...
+
+3.51. ka_method (str)
+
+   The SIP method type for keepalive requests.
+
+   Default value is “OPTIONS”.
+
+   Example 1.51. ka_method parameter usage
+...
+modparam("usrloc", "ka_method", "NOTIFY")
+...
+
+3.52. ka_from (str)
+
+   The SIP URI to be set in the From header of the keepalive requests.
+
+   Default value is “sip:server at kamailio.org”.
+
+   Example 1.52. ka_from parameter usage
+...
+modparam("usrloc", "ka_from", "sip:server at mydomain.com")
+...
+
+3.53. ka_domain (str)
+
+   The domain to be set in To header URI if the multi-domain is not
+   enabled. If multi-domain is enabled, then the domain from the location
+   record is used and this parameter is ignored.
+
+   Default value is “kamailio.org”.
+
+   Example 1.53. ka_domain parameter usage
+...
+modparam("usrloc", "ka_domain", "mydomain.com")
+...
+
 4. RPC Commands
 
    4.1. ul.dump