[sr-dev] git:master:0ad80449: permissions: document reload_delta parameter

[Victor Seva]

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

Author: Victor Seva <linuxmaniac at torreviejawireless.org>
Committer: Victor Seva <linuxmaniac at torreviejawireless.org>
Date: 2020-11-05T12:21:23+01:00

permissions: document reload_delta parameter

---

Modified: src/modules/permissions/doc/permissions_admin.xml

---

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

---

diff --git a/src/modules/permissions/doc/permissions_admin.xml b/src/modules/permissions/doc/permissions_admin.xml
index adca339d77..e3b65816e5 100644
--- a/src/modules/permissions/doc/permissions_admin.xml
+++ b/src/modules/permissions/doc/permissions_admin.xml
@@ -846,6 +846,33 @@ modparam("permissions", "load_backends", 1)
 </programlisting>
 		</example>
 	</section>
+	<section id ="permissions.p.reload_delta">
+		<title><varname>reload_delta</varname> (int)</title>
+		<para>
+		The number of seconds that have to be waited before executing a new
+		RPC reload. By default there is a rate limiting of maximum one reload
+		in five seconds.
+		</para>
+		<para>
+		If set to 0, no rate limit is configured. Note carefully: use this
+		configuration only in tests environments because executing two RPC
+		reloads of the same table at the same time can cause to kamailio
+		to crash.
+		</para>
+		<para>
+		<emphasis>
+			Default value is <quote>5</quote>.
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>reload_delta</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("permissions", "reload_delta", 1)
+...
+		</programlisting>
+		</example>
+	</section>
 	</section>
 
 	<section>
@@ -1278,8 +1305,8 @@ if (allow_trusted("$si", "any", "$ai")) {
 			different tables:  address table and
 			subnet table depending on the value of
 			the mask field (IPv6: 64 or smaller, IPv4: 32 or smaller).
-			Note that there is a rate limiting of maximum one reload in
-			five seconds.
+			Note that there is a rate limiting defined by 'reload_delta'
+			paramenter. By default is allowed maximum one reload in five seconds.
 		</para>
 		<para>Parameters: <emphasis>none</emphasis></para>
 	</section>
@@ -1361,8 +1388,8 @@ if (allow_trusted("$si", "any", "$ai")) {
 		<para>
 			Causes the permissions module to re-read the contents of
 			the trusted database table into cache memory.
-			Note that there is a rate limiting of maximum one reload in
-			five seconds.
+			Note that there is a rate limiting defined by 'reload_delta'
+			paramenter. By default is allowed maximum one reload in five seconds.
 		</para>
 		<para>Parameters: <emphasis>none</emphasis></para>
 	</section>