From e52c1f334fb98e00809226cde190da3406976348 Mon Sep 17 00:00:00 2001
From: Kamailio Dev <kamailio.dev@kamailio.org>
Date: Fri, 11 Sep 2020 22:16:12 +0200
Subject: [PATCH] modules: readme files regenerated - usrloc ... [skip ci]

---
 src/modules/usrloc/README | 51 ++++++++++++++++++++++++++++-----------
 1 file changed, 37 insertions(+), 14 deletions(-)

diff --git a/src/modules/usrloc/README b/src/modules/usrloc/README
index ac3a6b7bb63..d075042834c 100644
--- a/src/modules/usrloc/README
+++ b/src/modules/usrloc/README
@@ -94,8 +94,9 @@ Carsten Bock
               3.52. ka_from (str)
               3.53. ka_domain (str)
               3.54. ka_filter (int)
-              3.55. ka_loglevel (int)
-              3.56. ka_logmsg (str)
+              3.55. ka_timeout (int)
+              3.56. ka_loglevel (int)
+              3.57. ka_logmsg (str)
 
         4. RPC Commands
 
@@ -197,8 +198,9 @@ Carsten Bock
    1.52. ka_from parameter usage
    1.53. ka_domain parameter usage
    1.54. ka_filter parameter usage
-   1.55. ka_loglevel parameter usage
-   1.56. ka_logmsg parameter usage
+   1.55. Set ka_timeout parameter
+   1.56. ka_loglevel parameter usage
+   1.57. ka_logmsg parameter usage
 
 Chapter 1. Admin Guide
 
@@ -269,8 +271,9 @@ Chapter 1. Admin Guide
         3.52. ka_from (str)
         3.53. ka_domain (str)
         3.54. ka_filter (int)
-        3.55. ka_loglevel (int)
-        3.56. ka_logmsg (str)
+        3.55. ka_timeout (int)
+        3.56. ka_loglevel (int)
+        3.57. ka_logmsg (str)
 
    4. RPC Commands
 
@@ -404,8 +407,9 @@ Chapter 1. Admin Guide
    3.52. ka_from (str)
    3.53. ka_domain (str)
    3.54. ka_filter (int)
-   3.55. ka_loglevel (int)
-   3.56. ka_logmsg (str)
+   3.55. ka_timeout (int)
+   3.56. ka_loglevel (int)
+   3.57. ka_logmsg (str)
 
 3.1. nat_bflag (int)
 
@@ -683,8 +687,8 @@ modparam("usrloc", "desc_time_order", 1)
 3.25. timer_interval (int)
 
    Number of seconds between two timer runs. The module uses a timer to
-   delete expired contacts, synchronize with database and other tasks,
-   that need to be run periodically.
+   delete expired contacts, synchronize with database, send keepalives and
+   other tasks, that need to be run periodically.
 
    Default value is 60.
 
@@ -1163,19 +1167,38 @@ modparam("usrloc", "ka_domain", "mydomain.com")
 modparam("usrloc", "ka_filter", 1)
 ...
 
-3.55. ka_loglevel (int)
+3.55. ka_timeout (int)
+
+   The parameter sets the interval in seconds after which a contact is
+   removed from location table if it does not reply to SIP keepalives
+   (usually OPTIONS ping requests).
+
+   The features is available only for contacts that are stored in memory
+   (not working for db only mode of the usrloc module).
+
+   Keepalives are sent stateless, not using TM module. The value of this
+   parameter has to be few times higher than timer interval.
+
+   Default value is “0” (feature disabled).
+
+   Example 1.55. Set ka_timeout parameter
+...
+modparam("usrloc", "ka_timeout", 120)
+...
+
+3.56. ka_loglevel (int)
 
    The level to print the log message when the keepalive response is
    received. It should be a value between -5 (L_ALERT) and 3 (L_DBG).
 
    Default value is “255” (disabled).
 
-   Example 1.55. ka_loglevel parameter usage
+   Example 1.56. ka_loglevel parameter usage
 ...
 modparam("usrloc", "ka_loglevel", 1)
 ...
 
-3.56. ka_logmsg (str)
+3.57. ka_logmsg (str)
 
    The formatted log specification to be added to the message printed when
    the keepalive is received and roundtrip time is computed. The log
@@ -1187,7 +1210,7 @@ modparam("usrloc", "ka_loglevel", 1)
 
    Default value is “ to-uri: [$tu] remote-addr: [$sas]”.
 
-   Example 1.56. ka_logmsg parameter usage
+   Example 1.57. ka_logmsg parameter usage
 ...
 modparam("usrloc", "ka_logmsg", " to-uri: [$tu] remote-addr: [$sas]")
 ...