topos: added missing params to docs

(cherry picked from commit 956b5ae)
kamailio · Mar 21, 2016 · bea13a3 · bea13a3
1 parent 0a3174f
commit bea13a3
Show file tree

Hide file tree

Showing 2 changed files with 110 additions and 2 deletions.
diff --git a/modules/topos/README b/modules/topos/README
@@ -28,12 +28,18 @@ Daniel-Constantin Mierla
               3.1. db_url (str)
               3.2. mask_callid (int)
               3.3. sanity_checks (int)
+              3.4. branch_expires (int)
+              3.5. branch_dialog (int)
+              3.6. clean_inteval (int)
 
    List of Examples
 
    1.1. Set db_url parameter
    1.2. Set mask_callid parameter
    1.3. Set sanity_checks parameter
+   1.4. Set branch_expires parameter
+   1.5. Set branch_dialog parameter
+   1.6. Set clean_interval parameter
 
 Chapter 1. Admin Guide
 
@@ -50,6 +56,9 @@ Chapter 1. Admin Guide
         3.1. db_url (str)
         3.2. mask_callid (int)
         3.3. sanity_checks (int)
+        3.4. branch_expires (int)
+        3.5. branch_dialog (int)
+        3.6. clean_inteval (int)
 
 1. Overview
 
@@ -60,6 +69,8 @@ Chapter 1. Admin Guide
    The module is transparent for the configuration writer. It only needs
    to be loaded (tune the parameters if needed).
 
+   It works for SIP MESSAGE requests.
+
 2. Dependencies
 
    2.1. Kamailio Modules
@@ -84,6 +95,9 @@ Chapter 1. Admin Guide
    3.1. db_url (str)
    3.2. mask_callid (int)
    3.3. sanity_checks (int)
+   3.4. branch_expires (int)
+   3.5. branch_dialog (int)
+   3.6. clean_inteval (int)
 
 3.1. db_url (str)
 
@@ -121,3 +135,36 @@ modparam("topos", "mask_callid", 1)
 ...
 modparam("topoh", "sanity_checks", 1)
 ...
+
+3.4. branch_expires (int)
+
+   Interval in seconds after which the branch records are deleted.
+
+   Default value is 180 (3 min).
+
+   Example 1.4. Set branch_expires parameter
+...
+modparam("topos", "branch_expires", 300)
+...
+
+3.5. branch_dialog (int)
+
+   Interval in seconds after which the dialog records are deleted.
+
+   Default value is 10800 (3 hours).
+
+   Example 1.5. Set branch_dialog parameter
+...
+modparam("topos", "branch_dialog", 3600)
+...
+
+3.6. clean_inteval (int)
+
+   Interval in seconds to run the clean up of stored records.
+
+   Default value is 60 (1 min).
+
+   Example 1.6. Set clean_interval parameter
+...
+modparam("topos", "clean_interval", 30)
+...
diff --git a/modules/topos/doc/topos_admin.xml b/modules/topos/doc/topos_admin.xml
@@ -10,9 +10,9 @@
 <!-- Module User's Guide -->
 
 <chapter>
-	
+
 	<title>&adminguide;</title>
-	
+
 	<section>
 	<title>Overview</title>
 	<para>
@@ -25,6 +25,9 @@
 		The module is transparent for the configuration writer. It only needs to be
 		loaded (tune the parameters if needed).
 	</para>
+	<para>
+		It works for SIP MESSAGE requests.
+	</para>
 	</section>
 	<section>
 	<title>Dependencies</title>
@@ -123,6 +126,64 @@ modparam("topos", "mask_callid", 1)
 ...
 modparam("topoh", "sanity_checks", 1)
 ...
+</programlisting>
+		</example>
+	</section>
+	<section id="topos.p.branch_expires">
+		<title><varname>branch_expires</varname> (int)</title>
+		<para>
+			Interval in seconds after which the branch records are deleted.
+		</para>
+		<para>
+		<emphasis>
+			Default value is 180 (3 min).
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>branch_expires</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("topos", "branch_expires", 300)
+...
+</programlisting>
+		</example>
+	</section>
+	<section id="topos.p.branch_dialog">
+		<title><varname>branch_dialog</varname> (int)</title>
+		<para>
+			Interval in seconds after which the dialog records are deleted.
+		</para>
+		<para>
+		<emphasis>
+			Default value is 10800 (3 hours).
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>branch_dialog</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("topos", "branch_dialog", 3600)
+...
+</programlisting>
+		</example>
+	</section>
+	<section id="topos.p.clean_interval">
+		<title><varname>clean_inteval</varname> (int)</title>
+		<para>
+			Interval in seconds to run the clean up of stored
+			records.
+		</para>
+		<para>
+		<emphasis>
+			Default value is 60 (1 min).
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>clean_interval</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("topos", "clean_interval", 30)
+...
 </programlisting>
 		</example>
 	</section>