[sr-dev] git:master: modules_k/rls: Documented new "rls_cleanup" MI command

[Peter Dunkley]

Module: sip-router
Branch: master
Commit: c740f0fca228376159895874a2534ebe5c0d8df1
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=c740f0fca228376159895874a2534ebe5c0d8df1

Author: Peter Dunkley <peter.dunkley at crocodile-rcs.com>
Committer: Peter Dunkley <peter.dunkley at crocodile-rcs.com>
Date:   Mon Apr 23 19:27:21 2012 +0100

modules_k/rls: Documented new "rls_cleanup" MI command

---

 modules_k/rls/README            |   32 +++++++++++++++++++++++++++++---
 modules_k/rls/doc/rls_admin.xml |   26 ++++++++++++++++++++++++++
 2 files changed, 55 insertions(+), 3 deletions(-)

diff --git a/modules_k/rls/README b/modules_k/rls/README
index 40ebeae..955b16d 100644
--- a/modules_k/rls/README
+++ b/modules_k/rls/README
@@ -55,7 +55,11 @@ Anca-Maria Vamanu
               4.2. rls_handle_notify()
               4.3. rls_update_subs(uri, event)
 
-        5. Installation
+        5. MI Commands
+
+              5.1. rls_cleanup
+
+        6. Installation
 
    2. Developer Guide
 
@@ -134,7 +138,11 @@ Chapter 1. Admin Guide
         4.2. rls_handle_notify()
         4.3. rls_update_subs(uri, event)
 
-   5. Installation
+   5. MI Commands
+
+        5.1. rls_cleanup
+
+   6. Installation
 
 1. Overview
 
@@ -640,7 +648,25 @@ Within event_route[xhttp:request]:
                 break;
 ...
 
-5. Installation
+5. MI Commands
+
+   5.1. rls_cleanup
+
+5.1.  rls_cleanup
+
+   Manually triggers the cleanup functions forthe rls_watchers and
+   rls_presentity tables. Useful if you have set clean_period to zero or
+   less.
+
+   Name: rls_cleanup
+
+   Parameters: none
+
+   MI FIFO Command Format:
+                :rls_cleanup:fifo_reply
+                _empty_line_
+
+6. Installation
 
    The module requires 2 tables in Kamailio database: rls_presentity and
    rls_watchers.The SQL syntax to create them can be found in
diff --git a/modules_k/rls/doc/rls_admin.xml b/modules_k/rls/doc/rls_admin.xml
index db03b9f..18f784f 100644
--- a/modules_k/rls/doc/rls_admin.xml
+++ b/modules_k/rls/doc/rls_admin.xml
@@ -767,6 +767,32 @@ Within event_route[xhttp:request]:
 </section>
 
 <section>
+	<title>MI Commands</title>
+	<section>
+	  <title>
+		<function moreinfo="none">rls_cleanup</function>
+	  </title>
+	  <para>
+		Manually triggers the cleanup functions forthe rls_watchers and
+		rls_presentity tables. Useful if you have set
+		<varname>clean_period</varname> to zero or less.
+	  </para>
+	  <para>
+		Name: <emphasis>rls_cleanup</emphasis>
+	  </para>
+	  <para>Parameters: <emphasis>none</emphasis></para>
+
+	  <para>
+		MI FIFO Command Format:
+	  </para>
+	  <programlisting  format="linespecific">
+		:rls_cleanup:fifo_reply
+		_empty_line_
+	  </programlisting>
+	</section>
+</section>
+
+<section>
 	<title>Installation</title>
 	<para>
 	The module requires 2 tables in &kamailio; database: rls_presentity