From 31fa9c50bd6193851c53c1d66b8d517da5f67a15 Mon Sep 17 00:00:00 2001
From: Daniel-Constantin Mierla <miconda@gmail.com>
Date: Fri, 20 Nov 2015 12:32:55 +0100
Subject: [PATCH] dmq_usrloc: documentation for batch_size and batch_usleep
 params

---
 modules/dmq_usrloc/README                   | 39 ++++++++++++
 modules/dmq_usrloc/doc/dmq_usrloc_admin.xml | 69 +++++++++++++++++++++
 2 files changed, 108 insertions(+)

diff --git a/modules/dmq_usrloc/README b/modules/dmq_usrloc/README
index db192333837..5325413cd87 100644
--- a/modules/dmq_usrloc/README
+++ b/modules/dmq_usrloc/README
@@ -28,11 +28,15 @@ Andrey Rybkin
 
               3.1. enable (int)
               3.2. sync (int)
+              3.3. batch_size (int)
+              3.4. batch_usleep (int)
 
    List of Examples
 
    1.1. Set enable parameter
    1.2. Set sync parameter
+   1.3. Set batch size parameter
+   1.4. Set batch_usleep parameter
 
 Chapter 1. Admin Guide
 
@@ -47,6 +51,8 @@ Chapter 1. Admin Guide
 
         3.1. enable (int)
         3.2. sync (int)
+        3.3. batch_size (int)
+        3.4. batch_usleep (int)
 
 1. Overview
 
@@ -67,6 +73,8 @@ Chapter 1. Admin Guide
 
    3.1. enable (int)
    3.2. sync (int)
+   3.3. batch_size (int)
+   3.4. batch_usleep (int)
 
 3.1. enable (int)
 
@@ -95,3 +103,34 @@ modparam("dmq_usrloc", "enable", 1)
 ...
 modparam("dmq_usrloc", "sync", 0)
 ...
+
+3.3. batch_size (int)
+
+   The parameter controls whetner to throttle synchronization of all
+   contacts in batches. Once a batch of SIP requests is sent out, then
+   sleep for 'batch_usleep' microseconds. The value can be:
+     * <=0 - disabled (no batching)
+     * >0 - how many records to be sent in a batch
+
+   Default value is 0.
+
+   Example 1.3. Set batch size parameter
+...
+modparam("dmq_usrloc", "batch_size", 4000)
+...
+
+3.4. batch_usleep (int)
+
+   The parameter controls whetner to throttle synchronization of all
+   contacts in batches. Once a batch of SIP requests is sent out, then
+   sleep for 'batch_usleep' microseconds. The value can be:
+     * <=0 - no sleep (it disables the batching)
+     * >0 - how many microseconds to sleep before sending out another
+       batch of usrloc records.
+
+   Default value is 0.
+
+   Example 1.4. Set batch_usleep parameter
+...
+modparam("dmq_usrloc", "batch_usleep", 1000)
+...
diff --git a/modules/dmq_usrloc/doc/dmq_usrloc_admin.xml b/modules/dmq_usrloc/doc/dmq_usrloc_admin.xml
index a7da61d899e..3c0e2b188f1 100644
--- a/modules/dmq_usrloc/doc/dmq_usrloc_admin.xml
+++ b/modules/dmq_usrloc/doc/dmq_usrloc_admin.xml
@@ -105,6 +105,75 @@ modparam("dmq_usrloc", "enable", 1)
 ...
 modparam("dmq_usrloc", "sync", 0)
 ...
+</programlisting>
+	</example>
+	</section>
+	<section id="usrloc_dmq.p.batch_size">
+		<title><varname>batch_size</varname> (int)</title>
+		<para>
+			The parameter controls whetner to throttle synchronization of
+			all contacts in batches. Once a batch of SIP requests is sent out,
+			then sleep for 'batch_usleep' microseconds.
+			The value can be:
+			<itemizedlist>
+			<listitem>
+			<para>
+				&lt;=0 - disabled (no batching)
+			</para>
+			</listitem>
+			<listitem>
+			<para>
+				&gt;0 - how many records to be sent in a batch
+			</para>
+			</listitem>
+			</itemizedlist>
+		</para>
+		<para>
+		<emphasis>
+			Default value is 0.
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>batch size</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("dmq_usrloc", "batch_size", 4000)
+...
+</programlisting>
+	</example>
+	</section>
+	<section id="usrloc_dmq.p.batch_usleep">
+		<title><varname>batch_usleep</varname> (int)</title>
+		<para>
+			The parameter controls whetner to throttle synchronization of
+			all contacts in batches. Once a batch of SIP requests is sent out,
+			then sleep for 'batch_usleep' microseconds.
+			The value can be:
+			<itemizedlist>
+			<listitem>
+			<para>
+				&lt;=0 - no sleep (it disables the batching)
+			</para>
+			</listitem>
+			<listitem>
+			<para>
+				&gt;0 - how many microseconds to sleep before sending
+				out another batch of usrloc records.
+			</para>
+			</listitem>
+			</itemizedlist>
+		</para>
+		<para>
+		<emphasis>
+			Default value is 0.
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>batch_usleep</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("dmq_usrloc", "batch_usleep", 1000)
+...
 </programlisting>
 	</example>
 	</section>