dispatcher: docs for reload_delta parameter
authorDaniel-Constantin Mierla <miconda@gmail.com>
Mon, 20 May 2019 09:34:16 +0000 (11:34 +0200)
committerDaniel-Constantin Mierla <miconda@gmail.com>
Mon, 20 May 2019 09:34:16 +0000 (11:34 +0200)
- GH #1939

src/modules/dispatcher/doc/dispatcher_admin.xml

index 50fa5e4..a797c0b 100644 (file)
@@ -1009,6 +1009,32 @@ modparam("dispatcher", "ds_db_extra_attrs", "socket=socket;pref=prefix")
                </example>
        </section>
 
+       <section id="dispatcher.p.reload_delta">
+               <title><varname>reload_delta</varname> (int)</title>
+               <para>
+               The number of seconds that have to be waited before executing a new reload
+               of dispatcher records. 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 many RPC
+               reload commandss at the same time can cause unexpected behavior.
+               </para>
+               <para>
+               <emphasis>
+                       Default value is <quote>5</quote>.
+               </emphasis>
+               </para>
+               <example>
+               <title>Set <varname>reload_delta</varname> parameter</title>
+               <programlisting format="linespecific">
+...
+modparam("dispatcher", "reload_delta", 1)
+...
+               </programlisting>
+               </example>
+       </section>
        </section>
 
        <section>