[sr-dev] git:master: modules/tsilo: added RPC commands

[Federico Cabiddu]

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

Author: Federico Cabiddu <federico.cabiddu at gmail.com>
Committer: Federico Cabiddu <federico.cabiddu at gmail.com>
Date:   Wed Nov 12 11:58:16 2014 +0100

modules/tsilo: added RPC commands

---

 modules/tsilo/README              |   39 ++++++++++++++++++++++++++++++++++--
 modules/tsilo/doc/tsilo_admin.xml |   21 +++++++++++++++++++
 2 files changed, 57 insertions(+), 3 deletions(-)

diff --git a/modules/tsilo/README b/modules/tsilo/README
index 297c435..af1ade0 100644
--- a/modules/tsilo/README
+++ b/modules/tsilo/README
@@ -10,7 +10,7 @@ Federico Cabiddu
 
    <federico.cabiddu at gmail.com>
 
-   Copyright © 2014 Federico Cabiddu
+   Copyright © 2014 Federico Cabiddu
      __________________________________________________________________
 
    Table of Contents
@@ -38,6 +38,11 @@ Federico Cabiddu
               5.1. ts_dump
               5.2. ts_lookup
 
+        6. Exported RPC Functions
+
+              6.1. ts.dump
+              6.2. ts.lookup
+
    List of Examples
 
    1.1. Set hash_size parameter
@@ -70,6 +75,11 @@ Chapter 1. Admin Guide
         5.1. ts_dump
         5.2. ts_lookup
 
+   6. Exported RPC Functions
+
+        6.1. ts.dump
+        6.2. ts.lookup
+
 1. Overview
 
    This modules provides transaction storage for the Kamailio SIP Server
@@ -115,7 +125,7 @@ Chapter 1. Admin Guide
    must be a power of two, otherwise it will be rounded down to the
    nearest power of two.
 
-   Default value is “2048”.
+   Default value is "2048".
 
    Example 1.1. Set hash_size parameter
 ...
@@ -203,7 +213,7 @@ if (is_method("REGISTER")) {
 
    Parameters:
      * brief - (optional, may not be present); if equals to string
-       “brief”, a brief dump will be done (only RURI, without the
+       "brief", a brief dump will be done (only RURI, without the
        transaction(s) details)
 
 5.2.  ts_lookup
@@ -212,3 +222,26 @@ if (is_method("REGISTER")) {
 
    Parameters:
      * ruri - RURI for which we want to show the transactions.
+
+6. Exported RPC Functions
+
+   6.1. ts.dump
+   6.2. ts.lookup
+
+6.1. ts.dump
+
+   Dumps the content of the TSILO table
+
+   Name: ts.dump
+
+   RPC Command Format:
+                        kamcmd ts.dump
+
+6.2. ts.lookup
+
+   Dumps the transactions stored for the given RURI
+
+   Name: ts.lookup
+
+   RPC Command Format:
+                        kamcmd ts.lookup sip:abcd at example.com
diff --git a/modules/tsilo/doc/tsilo_admin.xml b/modules/tsilo/doc/tsilo_admin.xml
index 36180d1..32acf8b 100644
--- a/modules/tsilo/doc/tsilo_admin.xml
+++ b/modules/tsilo/doc/tsilo_admin.xml
@@ -231,4 +231,25 @@ if (is_method("REGISTER")) {
 			</itemizedlist>
 		</section>
 	</section>
+	<section>
+	<title>Exported RPC Functions</title>
+		<section>
+			<title><varname>ts.dump</varname></title>
+			<para>Dumps the content of the TSILO table</para>
+			<para>Name: <emphasis>ts.dump</emphasis></para>
+			<para>RPC Command Format:</para>
+			<programlisting  format="linespecific">
+			kamcmd ts.dump
+			</programlisting>
+		</section>
+		<section>
+			<title><varname>ts.lookup</varname></title>
+			<para>Dumps the transactions stored for the given RURI</para>
+			<para>Name: <emphasis>ts.lookup</emphasis></para>
+			<para>RPC Command Format:</para>
+			<programlisting  format="linespecific">
+			kamcmd ts.lookup sip:abcd at example.com
+			</programlisting>
+		</section>
+	</section>
 </chapter>