Bläddra i källkod

modules/tsilo: added RPC commands

Federico Cabiddu 10 år sedan
förälder
incheckning
dcfc166dad
2 ändrade filer med 57 tillägg och 3 borttagningar
  1. 36 3
      modules/tsilo/README
  2. 21 0
      modules/tsilo/doc/tsilo_admin.xml

+ 36 - 3
modules/tsilo/README

@@ -10,7 +10,7 @@ Federico Cabiddu
 
 
    <[email protected]>
    <[email protected]>
 
 
-   Copyright © 2014 Federico Cabiddu
+   Copyright © 2014 Federico Cabiddu
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -38,6 +38,11 @@ Federico Cabiddu
               5.1. ts_dump
               5.1. ts_dump
               5.2. ts_lookup
               5.2. ts_lookup
 
 
+        6. Exported RPC Functions
+
+              6.1. ts.dump
+              6.2. ts.lookup
+
    List of Examples
    List of Examples
 
 
    1.1. Set hash_size parameter
    1.1. Set hash_size parameter
@@ -70,6 +75,11 @@ Chapter 1. Admin Guide
         5.1. ts_dump
         5.1. ts_dump
         5.2. ts_lookup
         5.2. ts_lookup
 
 
+   6. Exported RPC Functions
+
+        6.1. ts.dump
+        6.2. ts.lookup
+
 1. Overview
 1. Overview
 
 
    This modules provides transaction storage for the Kamailio SIP Server
    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
    must be a power of two, otherwise it will be rounded down to the
    nearest power of two.
    nearest power of two.
 
 
-   Default value is “2048�.
+   Default value is "2048".
 
 
    Example 1.1. Set hash_size parameter
    Example 1.1. Set hash_size parameter
 ...
 ...
@@ -203,7 +213,7 @@ if (is_method("REGISTER")) {
 
 
    Parameters:
    Parameters:
      * brief - (optional, may not be present); if equals to string
      * 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)
        transaction(s) details)
 
 
 5.2.  ts_lookup
 5.2.  ts_lookup
@@ -212,3 +222,26 @@ if (is_method("REGISTER")) {
 
 
    Parameters:
    Parameters:
      * ruri - RURI for which we want to show the transactions.
      * 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:[email protected]

+ 21 - 0
modules/tsilo/doc/tsilo_admin.xml

@@ -231,4 +231,25 @@ if (is_method("REGISTER")) {
 			</itemizedlist>
 			</itemizedlist>
 		</section>
 		</section>
 	</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:[email protected]
+			</programlisting>
+		</section>
+	</section>
 </chapter>
 </chapter>