[sr-dev] git:master:bf0bafd1: uac: docs for reg_gc_interval param

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2019-07-02T18:37:00+02:00

uac: docs for reg_gc_interval param

---

Modified: src/modules/uac/doc/uac_admin.xml

---

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

---

diff --git a/src/modules/uac/doc/uac_admin.xml b/src/modules/uac/doc/uac_admin.xml
index e4971191a8..097609f13f 100644
--- a/src/modules/uac/doc/uac_admin.xml
+++ b/src/modules/uac/doc/uac_admin.xml
@@ -537,6 +537,31 @@ modparam("uac", "reg_active", 0)
 			</example>
 		</section>
 
+		<section id="uac.p.reg_gc_interval">
+			<title><varname>reg_gc_interval</varname> (int)</title>
+			<para>
+			Timer interval (in seconds) at which remote registrations are cleaned
+			up in case of failure or removed. When setting it take in consideration
+			the maximum value for retransmission timeout, this param should be greater
+			than it. This value also impacts how ofter the reload for remote
+			registrations table can be executed -- the RPC command will fail if
+			executed in less than reg_gc_interval value since the last reload.
+			</para>
+			<para>
+				<emphasis>
+				The default value is 150 seconds.
+				</emphasis>
+			</para>
+
+			<example>
+				<title>Set <varname>reg_gc_interval</varname> parameter</title>
+				<programlisting format="linespecific">
+...
+modparam("uac", "reg_gc_interval", 60)
+...
+				</programlisting>
+			</example>
+		</section>
 
 	</section>