Browse code

usrloc: docs for ka_timeout module parameter

(cherry picked from commit 2e9d4e2dc45bf5baab1bff9c13fc841b66793cb4)

Daniel-Constantin Mierla authored on 11/09/2020 20:06:45
Showing 1 changed files
... ...
@@ -604,8 +604,8 @@ modparam("usrloc", "desc_time_order", 1)
604 604
 		<title><varname>timer_interval</varname> (int)</title>
605 605
 		<para>
606 606
 		Number of seconds between two timer runs. The module uses a timer to
607
-		delete expired contacts, synchronize with database and other tasks,
608
-		that need to be run periodically.
607
+		delete expired contacts, synchronize with database, send keepalives
608
+		and other tasks, that need to be run periodically.
609 609
 		</para>
610 610
 		<para>
611 611
 		<emphasis>
... ...
@@ -1424,6 +1424,36 @@ modparam("usrloc", "ka_filter", 1)
1424 1424
 		</example>
1425 1425
 	</section>
1426 1426
 
1427
+	<section id="usrloc.p.ka_timeout">
1428
+		<title><varname>ka_timeout</varname> (int)</title>
1429
+		<para>
1430
+		The parameter sets the interval in seconds after which a
1431
+		contact is removed from location table if it does not reply to SIP
1432
+		keepalives (usually OPTIONS ping requests).
1433
+		</para>
1434
+		<para>
1435
+		The features is available only for contacts that are stored in memory
1436
+		(not working for db only mode of the usrloc module).
1437
+		</para>
1438
+		<para>
1439
+		Keepalives are sent stateless, not using TM module. The value of this
1440
+		parameter has to be few times higher than timer interval.
1441
+		</para>
1442
+		<para>
1443
+		<emphasis>
1444
+			Default value is <quote>0</quote> (feature disabled).
1445
+		</emphasis>
1446
+		</para>
1447
+		<example>
1448
+		<title>Set <varname>ka_timeout</varname> parameter</title>
1449
+		<programlisting format="linespecific">
1450
+...
1451
+modparam("usrloc", "ka_timeout", 120)
1452
+...
1453
+</programlisting>
1454
+		</example>
1455
+	</section>
1456
+
1427 1457
 	<section id="usrloc.p.ka_loglevel">
1428 1458
 		<title><varname>ka_loglevel</varname> (int)</title>
1429 1459
 		<para>