[sr-dev] git:master:2e9d4e2d: usrloc: docs for ka_timeout module parameter

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2020-09-11T22:07:31+02:00

usrloc: docs for ka_timeout module parameter

---

Modified: src/modules/usrloc/doc/usrloc_admin.xml

---

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

---

diff --git a/src/modules/usrloc/doc/usrloc_admin.xml b/src/modules/usrloc/doc/usrloc_admin.xml
index 396d89828d..4b624fb81f 100644
--- a/src/modules/usrloc/doc/usrloc_admin.xml
+++ b/src/modules/usrloc/doc/usrloc_admin.xml
@@ -604,8 +604,8 @@ modparam("usrloc", "desc_time_order", 1)
 		<title><varname>timer_interval</varname> (int)</title>
 		<para>
 		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.
 		</para>
 		<para>
 		<emphasis>
@@ -1424,6 +1424,36 @@ modparam("usrloc", "ka_filter", 1)
 		</example>
 	</section>
 
+	<section id="usrloc.p.ka_timeout">
+		<title><varname>ka_timeout</varname> (int)</title>
+		<para>
+		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).
+		</para>
+		<para>
+		The features is available only for contacts that are stored in memory
+		(not working for db only mode of the usrloc module).
+		</para>
+		<para>
+		Keepalives are sent stateless, not using TM module. The value of this
+		parameter has to be few times higher than timer interval.
+		</para>
+		<para>
+		<emphasis>
+			Default value is <quote>0</quote> (feature disabled).
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>ka_timeout</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("usrloc", "ka_timeout", 120)
+...
+</programlisting>
+		</example>
+	</section>
+
 	<section id="usrloc.p.ka_loglevel">
 		<title><varname>ka_loglevel</varname> (int)</title>
 		<para>