Răsfoiți Sursa

modules_k/rls: Documented new "rls_cleanup" MI command

Peter Dunkley 13 ani în urmă
părinte
comite
c740f0fca2
2 a modificat fișierele cu 55 adăugiri și 3 ștergeri
  1. 29 3
      modules_k/rls/README
  2. 26 0
      modules_k/rls/doc/rls_admin.xml

+ 29 - 3
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

+ 26 - 0
modules_k/rls/doc/rls_admin.xml

@@ -766,6 +766,32 @@ Within event_route[xhttp:request]:
 	</section>
 </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>