[sr-dev] git:master:536b0ab1: dispatcher: documentation for ds_timer_mode parameter

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2016-01-24T12:52:41+01:00

dispatcher: documentation for ds_timer_mode parameter

---

Modified: modules/dispatcher/doc/dispatcher_admin.xml

---

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

---

diff --git a/modules/dispatcher/doc/dispatcher_admin.xml b/modules/dispatcher/doc/dispatcher_admin.xml
index 99b7d0c..6f44754 100644
--- a/modules/dispatcher/doc/dispatcher_admin.xml
+++ b/modules/dispatcher/doc/dispatcher_admin.xml
@@ -804,11 +804,13 @@ modparam("dispatcher", "force_dst", 1)
 	<section id="dispatcher.p.ds_default_socket">
 		<title><varname>ds_default_socket</varname> (str)</title>
 		<para>
-		Default socket to be used for sending pings and dispatching requests when a gateway has no send socket configured.
+			Default socket to be used for sending pings and dispatching requests
+			when a gateway has no send socket configured.
 		</para>
 		<para>
 		<emphasis>
-			By default no default socket is defined, the first configuration script <emphasis>listen</emphasis> directive is used.
+			By default no default socket is defined, the first configuration
+			script <emphasis>listen</emphasis> directive is used.
 		</emphasis>
 		</para>
 		<example>
@@ -821,6 +823,45 @@ modparam("dispatcher", "force_dst", 1)
 		</example>
 	</section>
 
+ 	<section id="dispatcher.p.ds_timer_mode">
+ 		<title><varname>ds_timer_mode</varname> (int)</title>
+ 		<para>
+			Specify the timer process to be used by the module for
+			keepalives and active dialogs tracking. 
+		</para>
+		<para>
+			It can be set to:
+		</para>
+		<itemizedlist>
+		<listitem>
+			<para>0 - use main timer process.</para>
+		</listitem>
+		<listitem>
+			<para>1 - use secondary timer process.</para>
+		</listitem>
+		</itemizedlist>
+
+ 		<para>
+			On a server with a lot of traffic, using secondary
+			timer can help with performances, because the main timer
+			can be overloaded by taking care of transactions retransmissions
+			and expirations of items in memory.
+		</para>
+		<para>
+ 		<emphasis>
+ 			Default value is <quote>0</quote>.
+ 		</emphasis>
+ 		</para>
+ 		<example>
+ 		<title>Set the <quote>ds_timer_mode</quote> parameter</title>
+ <programlisting format="linespecific">
+ ...
+ modparam("dispatcher", "ds_timer_mode", 1)
+ ...
+ </programlisting>
+ 		</example>
+	</section>
+
 	</section>
 
 	<section>