[sr-dev] git:master:bfb1d0ec: usrloc: documentation for db_timer_clean parameter

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2016-01-24T17:39:14+01:00

usrloc: documentation for db_timer_clean parameter

---

Modified: modules/usrloc/README
Modified: modules/usrloc/doc/usrloc_admin.xml

---

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

---

diff --git a/modules/usrloc/README b/modules/usrloc/README
index 0f2d56b..b949dab 100644
--- a/modules/usrloc/README
+++ b/modules/usrloc/README
@@ -12,12 +12,8 @@ Edited by
 
 Jan Janak
 
-Edited by
-
 Bogdan-Andrei Iancu
 
-Edited by
-
 Carsten Bock
 
    ng-voice GmbH
@@ -85,6 +81,7 @@ Carsten Bock
               3.39. db_raw_fetch_type (int)
               3.40. db_insert_null (int)
               3.41. skip_remote_socket (int)
+              3.42. db_timer_clean (int)
 
         4. Functions
         5. MI Commands
@@ -183,6 +180,7 @@ Carsten Bock
    1.39. Set db_raw_fetch_type parameter
    1.40. Set db_insert_null parameter
    1.41. Set skip_remote_socket parameter
+   1.42. Set db_timer_clean parameter
 
 Chapter 1. Admin Guide
 
@@ -240,6 +238,7 @@ Chapter 1. Admin Guide
         3.39. db_raw_fetch_type (int)
         3.40. db_insert_null (int)
         3.41. skip_remote_socket (int)
+        3.42. db_timer_clean (int)
 
    4. Functions
    5. MI Commands
@@ -371,6 +370,7 @@ Chapter 1. Admin Guide
    3.39. db_raw_fetch_type (int)
    3.40. db_insert_null (int)
    3.41. skip_remote_socket (int)
+   3.42. db_timer_clean (int)
 
 3.1. nat_bflag (integer)
 
@@ -928,6 +928,19 @@ modparam("usrloc", "db_insert_null", 1)
 modparam("usrloc", "skip_remote_socket", 1)
 ...
 
+3.42. db_timer_clean (int)
+
+   Enable (1) or disable (0) cleaning of expired db records on timer basis
+   for db_mode WRITE-BACK and WRITE-THROUGH. It uses the secondary timer
+   process.
+
+   Default value is "0".
+
+   Example 1.42. Set db_timer_clean parameter
+...
+modparam("usrloc", "db_timer_clean", 1)
+...
+
 4. Functions
 
    There are no exported functions that could be used in scripts.
diff --git a/modules/usrloc/doc/usrloc_admin.xml b/modules/usrloc/doc/usrloc_admin.xml
index 1d2b0c8..89c4756 100644
--- a/modules/usrloc/doc/usrloc_admin.xml
+++ b/modules/usrloc/doc/usrloc_admin.xml
@@ -1086,6 +1086,28 @@ modparam("usrloc", "skip_remote_socket", 1)
 		</example>
 	</section>
 
+	<section id="usrloc.p.db_timer_clean">
+		<title><varname>db_timer_clean</varname> (int)</title>
+		<para>
+			Enable (1) or disable (0) cleaning of expired db records on
+			timer basis for db_mode WRITE-BACK and WRITE-THROUGH. It uses
+			the secondary timer process.
+		</para>
+		<para>
+		<emphasis>
+			Default value is <quote>0</quote>.
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>db_timer_clean</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("usrloc", "db_timer_clean", 1)
+...
+</programlisting>
+		</example>
+	</section>
+
 	</section>
 
 	<section>