modules: readme files regenerated - cnxcc ...
authorKamailio Dev <kamailio.dev@kamailio.org>
Mon, 2 Jan 2017 13:31:16 +0000 (14:31 +0100)
committerKamailio Dev <kamailio.dev@kamailio.org>
Mon, 2 Jan 2017 13:31:16 +0000 (14:31 +0100)
src/modules/cnxcc/README
src/modules/kex/README
src/modules/mqueue/README
src/modules/outbound/README
src/modules/pipelimit/README
src/modules/sipcapture/README
src/modules/siptrace/README

index 87605dd..5ec0fa9 100644 (file)
@@ -32,11 +32,12 @@ Carlos Ruiz Díaz
               4.4. cnxcc_set_max_channel()
               4.5. cnxcc_terminate_all()
 
-        5. Exported RPC Commands
+        5. RPC Commands
 
               5.1. cnxcc.active_clients
               5.2. cnxcc.check_client
               5.3. cnxcc.kill_call
+              5.4. cnxcc.stats
 
         6. Events
         7. Web Interface
@@ -76,11 +77,12 @@ Chapter 1. Admin Guide
         4.4. cnxcc_set_max_channel()
         4.5. cnxcc_terminate_all()
 
-   5. Exported RPC Commands
+   5. RPC Commands
 
         5.1. cnxcc.active_clients
         5.2. cnxcc.check_client
         5.3. cnxcc.kill_call
+        5.4. cnxcc.stats
 
    6. Events
    7. Web Interface
@@ -283,11 +285,12 @@ if (!cnxcc_terminate_all("$var(customer)")) {
 }
 ...
 
-5. Exported RPC Commands
+5. RPC Commands
 
    5.1. cnxcc.active_clients
    5.2. cnxcc.check_client
    5.3. cnxcc.kill_call
+   5.4. cnxcc.stats
 
 5.1. cnxcc.active_clients
 
@@ -316,6 +319,15 @@ if (!cnxcc_terminate_all("$var(customer)")) {
    Example:
             kamcmd cnxcc.kill_call qumojlaahitafih@carlosrdcnx-laptop.site
 
+5.4. cnxcc.stats
+
+   List credit control stats.
+
+   Parameters: none
+
+   Example:
+            kamcmd cnxcc.stats
+
 6. Events
 
    When a call is forced to end an event route is automatically invoked.
index 4909bac..963b8b6 100644 (file)
@@ -53,25 +53,22 @@ Ovidiu Sas
               3.13. resetdebug()
               3.14. km_append_branch([uri])
 
-        4. MI Commands
+        4. RPC Commands
 
-              4.1. arg
-              4.2. kill
-              4.3. pwd
-              4.4. uptime
+              4.1. core.arg
+              4.2. core.kill
+              4.3. core.pwd
+              4.4. core.uptime
               4.5. version
-              4.6. which
+              4.6. system.listMethods
               4.7. get_statistics
-              4.8. reset_statistics
+              4.8. stats.reset_statistics
               4.9. clear_statistics
-
-        5. RPC Commands
-
-              5.1. pkg.stats
-              5.2. stats.get_statistics
-              5.3. stats.reset_statistics
-              5.4. stats.clear_statistics
-              5.5. mod.stats module_name/all pkg/shm/all
+              4.10. pkg.stats
+              4.11. stats.get_statistics
+              4.12. stats.reset_statistics
+              4.13. stats.clear_statistics
+              4.14. mod.stats module_name/all pkg/shm/all
 
    List of Examples
 
@@ -116,25 +113,22 @@ Chapter 1. Admin Guide
         3.13. resetdebug()
         3.14. km_append_branch([uri])
 
-   4. MI Commands
+   4. RPC Commands
 
-        4.1. arg
-        4.2. kill
-        4.3. pwd
-        4.4. uptime
+        4.1. core.arg
+        4.2. core.kill
+        4.3. core.pwd
+        4.4. core.uptime
         4.5. version
-        4.6. which
+        4.6. system.listMethods
         4.7. get_statistics
-        4.8. reset_statistics
+        4.8. stats.reset_statistics
         4.9. clear_statistics
-
-   5. RPC Commands
-
-        5.1. pkg.stats
-        5.2. stats.get_statistics
-        5.3. stats.reset_statistics
-        5.4. stats.clear_statistics
-        5.5. mod.stats module_name/all pkg/shm/all
+        4.10. pkg.stats
+        4.11. stats.get_statistics
+        4.12. stats.reset_statistics
+        4.13. stats.clear_statistics
+        4.14. mod.stats module_name/all pkg/shm/all
 
 1. Overview
 
@@ -401,141 +395,144 @@ resetdebug();
    This function was replaced by append_branch() from corex module,
    starting with version 4.0.0.
 
-4. MI Commands
+4. RPC Commands
 
-   4.1. arg
-   4.2. kill
-   4.3. pwd
-   4.4. uptime
+   4.1. core.arg
+   4.2. core.kill
+   4.3. core.pwd
+   4.4. core.uptime
    4.5. version
-   4.6. which
+   4.6. system.listMethods
    4.7. get_statistics
-   4.8. reset_statistics
+   4.8. stats.reset_statistics
    4.9. clear_statistics
+   4.10. pkg.stats
+   4.11. stats.get_statistics
+   4.12. stats.reset_statistics
+   4.13. stats.clear_statistics
+   4.14. mod.stats module_name/all pkg/shm/all
 
-4.1.  arg
+4.1.  core.arg
 
    Print command line arguments.
 
-   Name: arg
+   Name: core.arg
 
    Parameters: none.
 
-   MI FIFO Command Format:
-                :arg:_reply_fifo_file_
-                _empty_line_
+   RPC Command Format:
+...
+kamcmd core.arg
+...
 
-4.2.  kill
+4.2.  core.kill
 
    Kill the application.
 
-   Name: kill
+   Name: core.kill
 
    Parameters: none.
 
-   MI FIFO Command Format:
-                :kill:_reply_fifo_file_
-                _empty_line_
+   RPC Command Format:
+...
+kamcmd core.kill
+...
 
-4.3.  pwd
+4.3.  core.pwd
 
    Print working directory.
 
-   Name: pwd
+   Name: core.pwd
 
    Parameters: none.
 
-   MI FIFO Command Format:
-                :pwd:_reply_fifo_file_
-                _empty_line_
+   RPC Command Format:
+...
+kamcmd core.pwd
+...
 
-4.4.  uptime
+4.4.  core.uptime
 
    Print uptime.
 
-   Name: uptime
+   Name: core.uptime
 
    Parameters: none.
 
-   MI FIFO Command Format:
-                :uptime:_reply_fifo_file_
-                _empty_line_
+   RPC Command Format:
+...
+kamcmd core.uptime
+...
 
 4.5.  version
 
    Print version information.
 
-   Name: version
+   Name: core.version
 
    Parameters: none.
 
-   MI FIFO Command Format:
-                :version:_reply_fifo_file_
-                _empty_line_
+   RPC Command Format:
+...
+kamcmd core.version
+...
 
-4.6.  which
+4.6.  system.listMethods
 
-   Print list of available MI commands.
+   Print list of available RPC commands.
 
    Name: which
 
    Parameters: none.
 
-   MI FIFO Command Format:
-                :which:_reply_fifo_file_
-                _empty_line_
+   RPC Command Format:
+...
+kamcmd system.listMethods
+...
 
 4.7.  get_statistics
 
    Print the list of available internal statistics.
 
-   Name: get_statistics
+   Name: stats.get_statistics
 
    Parameters: statsid - which statistics to be printed. If set to 'all'
    then all statistics are printed; if set to 'statsgroup:' then all
    statistics in the group are printed; if set to 'statsname' then the
    statistics identified by the name is printed.
 
-   MI FIFO Command Format:
-                :get_statistics:_reply_fifo_file_
-                _statsid_
-                _empty_line_
+   RPC Command Format:
+...
+kamcmd stats.get_statistics
+...
 
-4.8.  reset_statistics
+4.8.  stats.reset_statistics
 
    Reset internal statistics.
 
-   Name: reset_statistics
+   Name: statsreset_statistics
 
    Parameters: statsid - which statistics to be reset, give as name.
 
-   MI FIFO Command Format:
-                :reset_statistics:_reply_fifo_file_
-                _statsid_
-                _empty_line_
+   RPC Command Format:
+...
+kamcmd reset_statistics _statsid_
+...
 
 4.9.  clear_statistics
 
    Return statistics and reset their value in one command.
 
-   Name: get_statistics
+   Name: stats.get_statistics
 
    Parameters: statsid - same as for get_statistics.
 
-   MI FIFO Command Format:
-                :clear_statistics:_reply_fifo_file_
-                _statsid_
-                _empty_line_
-
-5. RPC Commands
-
-   5.1. pkg.stats
-   5.2. stats.get_statistics
-   5.3. stats.reset_statistics
-   5.4. stats.clear_statistics
-   5.5. mod.stats module_name/all pkg/shm/all
+   RPC Command Format:
+...
+kamcmd clear_statistics _statsid_
+...
 
-5.1.  pkg.stats
+4.10.  pkg.stats
 
    Print private memory (pkg) usage statistics per process. It can take
    optinally a filter to print statistics only for a specific process or
@@ -553,7 +550,7 @@ resetdebug();
                 kamcmd pkg.stats rank 1
                 kamcmd pkg.stats index 10
 
-5.2.  stats.get_statistics
+4.11.  stats.get_statistics
 
    Print the list of available internal statistics.
 
@@ -568,7 +565,7 @@ resetdebug();
                 kamcmd stats.get_statistics unsupported_methods
                 kamcmd stats.get_statistics shmem: fwd_requests fwd_replies
 
-5.3.  stats.reset_statistics
+4.12.  stats.reset_statistics
 
    Reset internal statistics.
 
@@ -580,7 +577,7 @@ resetdebug();
                 kamcmd stats.reset_statistics unsupported_methods
                 kamcmd stats.reset_statistics shmem: fwd_requests fwd_replies
 
-5.4.  stats.clear_statistics
+4.13.  stats.clear_statistics
 
    Return statistics and reset their value in one command.
 
@@ -592,7 +589,7 @@ resetdebug();
                 kamcmd stats.reset_statistics unsupported_methods
                 kamcmd stats.reset_statistics shmem: fwd_requests fwd_replies
 
-5.5.  mod.stats module_name/all pkg/shm/all
+4.14.  mod.stats module_name/all pkg/shm/all
 
    Print private(pkg) or shared(shm) memory currently allocated a given
    module or by all modules.
@@ -626,7 +623,7 @@ Module: kex
     // this is the pkg zone of the module
     // function_name(line_where_pkg_malloc_was_called): size_alloc'ed_by_pkg_mal
 loc
-    init_mi_uptime(74): 56
+    init_rpc_uptime(74): 56
     Total: 56
 }
 {
index e4a4cec..139597f 100644 (file)
@@ -1,193 +1,2 @@
-mqueue Module
 
-Elena-Ramona Modroiu
 
-   asipto.com
-
-Edited by
-
-Elena-Ramona Modroiu
-
-   <ramona@asipto.com>
-
-Edited by
-
-Alex Balashov
-
-   Evariste Systems
-   <abalashov@evaristesys.com>
-
-   Copyright © 2010 Elena-Ramona Modroiu (asipto.com)
-     __________________________________________________________________
-
-   Table of Contents
-
-   1. Admin Guide
-
-        1. Overview
-        2. Dependencies
-
-              2.1. Kamailio Modules
-              2.2. External Libraries or Applications
-
-        3. Parameters
-
-              3.1. mqueue (string)
-
-        4. Functions
-
-              4.1. mq_add(queue, key, value)
-              4.2. mq_fetch(queue)
-              4.3. mq_pv_free(queue)
-              4.4. mq_size(queue)
-
-        5. Exported Pseudo-variables
-
-   List of Examples
-
-   1.1. Set mqueue parameter
-   1.2. mq_add usage
-   1.3. mq_fetch usage
-   1.4. mq_pv_free usage
-   1.5. mq_size usage
-
-Chapter 1. Admin Guide
-
-   Table of Contents
-
-   1. Overview
-   2. Dependencies
-
-        2.1. Kamailio Modules
-        2.2. External Libraries or Applications
-
-   3. Parameters
-
-        3.1. mqueue (string)
-
-   4. Functions
-
-        4.1. mq_add(queue, key, value)
-        4.2. mq_fetch(queue)
-        4.3. mq_pv_free(queue)
-        4.4. mq_size(queue)
-
-   5. Exported Pseudo-variables
-
-1. Overview
-
-   The mqueue module offers a generic message queue system in shared
-   memory for inter-process communication using the config file. One
-   example of usage is to send time consuming operations to one or several
-   timer processes that consumes items in the queue, without affecting SIP
-   message handling in the socket-listening process.
-
-   There can be many defined queues. Access to queued values is done via
-   pseudo variables.
-
-2. Dependencies
-
-   2.1. Kamailio Modules
-   2.2. External Libraries or Applications
-
-2.1. Kamailio Modules
-
-   The following modules must be loaded before this module:
-     * None.
-
-2.2. External Libraries or Applications
-
-   The following libraries or applications must be installed before
-   running Kamailio with this module loaded:
-     * None.
-
-3. Parameters
-
-   3.1. mqueue (string)
-
-3.1. mqueue (string)
-
-   Definition of a memory queue
-
-   Default value is “none”.
-
-   Value must be a list of parameters: attr=value;... The attribute 'name'
-   is mandatory, defining the name of the queue. Optional attribute 'size'
-   specifies the maximum number of items in queue, if it is execeeded the
-   oldest one is removed.
-
-   The parameter can be set many times, each holding the definition of one
-   queue.
-
-   Example 1.1. Set mqueue parameter
-...
-modparam("mqueue", "mqueue", "name=myq;size=20;")
-modparam("mqueue", "mqueue", "name=qaz")
-...
-
-4. Functions
-
-   4.1. mq_add(queue, key, value)
-   4.2. mq_fetch(queue)
-   4.3. mq_pv_free(queue)
-   4.4. mq_size(queue)
-
-4.1.  mq_add(queue, key, value)
-
-   Add a new item (key, value) in the queue. If max size of queue is
-   exceeded, the oldest one is removed.
-
-   Example 1.2. mq_add usage
-...
-mq_add("myq", "$rU", "call from $fU");
-...
-
-4.2.  mq_fetch(queue)
-
-   Take oldest item from queue and fill $mqk(queue) and $mqv(queue) pseudo
-   variables.
-
-   Return: true on success (1); false on failure (-1) or no item fetched
-   (-2).
-
-   Example 1.3. mq_fetch usage
-...
-while(mq_fetch("myq"))
-{
-   xlog("$mqk(myq) - $mqv(myq)\n");
-}
-...
-
-4.3.  mq_pv_free(queue)
-
-   Free the item fetched in pseudo-variables. It is optional, a new fetch
-   frees the previous values.
-
-   Example 1.4. mq_pv_free usage
-...
-mq_pv_free("myq");
-...
-
-4.4.  mq_size(queue)
-
-   Returns the current number of elements in the mqueue.
-
-   If the mqueue is empty, the function returns -1. If the mqueue is not
-   found, the function returns -2.
-
-   Example 1.5. mq_size usage
-...
-$var(q_size) = mq_size("queue");
-xlog("L_INFO", "Size of queue is: $var(q_size)\n");
-...
-
-5. Exported Pseudo-variables
-
-     * $mqv(mqueue) - the most recent item key fetched from the specified
-       mqueue
-     * $mqv(mqueue) - the most recent item value fetched from the
-       specified mqueue
-     * $mq_size(mqueue) - the size of the specified mqueue
-
-   Exported pseudo-variables are documented at
-   http://www.kamailio.org/wiki/.
index fa38640..faeaf1b 100644 (file)
@@ -26,9 +26,6 @@ Peter Dunkley
               3.1. force_outbound_flag (integer)
               3.2. force_no_outbound_flag (integer)
 
-        4. Functions
-        5. MI Commands
-
    List of Examples
 
    1.1. Edge Proxy Configuration
@@ -55,9 +52,6 @@ Chapter 1. Admin Guide
         3.1. force_outbound_flag (integer)
         3.2. force_no_outbound_flag (integer)
 
-   4. Functions
-   5. MI Commands
-
 1. Overview
 
    1.1. Edge Proxy Keep-Alives (STUN)
@@ -522,11 +516,3 @@ modparam("outbound", "force_outbound_flag", 1)
 ...
 modparam("outbound", "force_no_outbound_flag", 2)
 ...
-
-4. Functions
-
-   None
-
-5. MI Commands
-
-   None
index e9872ec..980ad07 100644 (file)
@@ -49,23 +49,14 @@ Daniel-Constantin Mierla
               4.1. pl_check(name [, algorithm, limit])
               4.2. pl_drop([ [min ], max ])
 
-        5. MI Commands
+        5. RPC Commands
 
-              5.1. pl_stats
-              5.2. pl_set_pipe
-              5.3. pl_get_pipes
-              5.4. pl_set_pid
-              5.5. pl_get_pid
-              5.6. pl_push_load
-
-        6. RPC Commands
-
-              6.1. pl.stats
-              6.2. pl.set_pipe
-              6.3. pl.get_pipes
-              6.4. pl.set_pid
-              6.5. pl.get_pid
-              6.6. pl.push_load
+              5.1. pl.stats
+              5.2. pl.set_pipe
+              5.3. pl.get_pipes
+              5.4. pl.set_pid
+              5.5. pl.get_pid
+              5.6. pl.push_load
 
    List of Examples
 
@@ -113,23 +104,14 @@ Chapter 1. Admin Guide
         4.1. pl_check(name [, algorithm, limit])
         4.2. pl_drop([ [min ], max ])
 
-   5. MI Commands
-
-        5.1. pl_stats
-        5.2. pl_set_pipe
-        5.3. pl_get_pipes
-        5.4. pl_set_pid
-        5.5. pl_get_pid
-        5.6. pl_push_load
-
-   6. RPC Commands
+   5. RPC Commands
 
-        6.1. pl.stats
-        6.2. pl.set_pipe
-        6.3. pl.get_pipes
-        6.4. pl.set_pid
-        6.5. pl.get_pid
-        6.6. pl.push_load
+        5.1. pl.stats
+        5.2. pl.set_pipe
+        5.3. pl.get_pipes
+        5.4. pl.set_pid
+        5.5. pl.get_pid
+        5.6. pl.push_load
 
 1. Overview
 
@@ -449,113 +431,16 @@ with unexpected retcode=$var(check_result)\n");
         }
 ...
 
-5. MI Commands
-
-   5.1. pl_stats
-   5.2. pl_set_pipe
-   5.3. pl_get_pipes
-   5.4. pl_set_pid
-   5.5. pl_get_pid
-   5.6. pl_push_load
-
-5.1.  pl_stats
-
-   Lists the parameters and variables in the pipelimit module.
-
-   Name: pl_stats
-
-   Parameters: none
-
-   MI FIFO Command Format:
-                :pl_stats:_reply_fifo_file_
-                _empty_line_
-
-5.2.  pl_set_pipe
-
-   Sets the pipe parameters for the given pipe id.
-
-   Name: pl_set_pipe
-
-   Parameters:
-     * pipe_id - pipe id.
-     * pipe_algorithm - the algorithm assigned to the given pipe id.
-     * pipe_limit - the limit assigned to the given pipe id.
-
-   MI FIFO Command Format:
-                :pl_set_pipe:_reply_fifo_file_
-                2
-                RED
-                10
-                _empty_line_
-
-5.3.  pl_get_pipes
-
-   Gets the list of in use pipes.
-
-   Name: pl_get_pipes
-
-   Parameters: none
-
-   MI FIFO Command Format:
-                :pl_get_pipes:_reply_fifo_file_
-                _empty_line_
-
-5.4.  pl_set_pid
-
-   Sets the PID Controller parameters for the Feedback Algorithm.
-
-   Name: pl_set_pid
-
-   Parameters:
-     * ki - the integral parameter.
-     * kp - the proportional parameter.
-     * kd - the derivative parameter.
-
-   MI FIFO Command Format:
-                :pl_set_pid:_reply_fifo_file_
-                0.5
-                0.5
-                0.5
-                _empty_line_
-
-5.5.  pl_get_pid
-
-   Gets the list of in use PID Controller parameters.
-
-   Name: pl_get_pid
-
-   Parameters: none
-
-   MI FIFO Command Format:
-                :pl_get_pid:_reply_fifo_file_
-                _empty_line_
-
-5.6.  pl_push_load
-
-   Force the value of the load parameter. This command is useful for
-   testing the Feedback algorithm.
-
-   Name: pl_push_load
-
-   Parameters:
-     * load - the forced value of load (it must be greater then 0.0 and
-       smaller then 1.0).
-
-   MI FIFO Command Format:
-                :pl_push_load:_reply_fifo_file_
-                0.85
-                _empty_line_
-
-6. RPC Commands
+5. RPC Commands
 
-   6.1. pl.stats
-   6.2. pl.set_pipe
-   6.3. pl.get_pipes
-   6.4. pl.set_pid
-   6.5. pl.get_pid
-   6.6. pl.push_load
+   5.1. pl.stats
+   5.2. pl.set_pipe
+   5.3. pl.get_pipes
+   5.4. pl.set_pid
+   5.5. pl.get_pid
+   5.6. pl.push_load
 
-6.1.  pl.stats
+5.1.  pl.stats
 
    Lists the parameters and variabiles in the pipelimit module: pipe id,
    pipe load and pipe couter.
@@ -567,7 +452,7 @@ with unexpected retcode=$var(check_result)\n");
    RPC Command Format:
         kamcmd pl.stats
 
-6.2.  pl.set_pipe
+5.2.  pl.set_pipe
 
    Sets the pipe parameters for the given pipe id.
 
@@ -581,7 +466,7 @@ with unexpected retcode=$var(check_result)\n");
    RPC Command Format:
         kamcmd pl.set_pipe 2 RED 10
 
-6.3.  pl.get_pipes
+5.3.  pl.get_pipes
 
    Gets the list of in use pipes.
 
@@ -592,7 +477,7 @@ with unexpected retcode=$var(check_result)\n");
    RPC Command Format:
         kamcmd pl.get_pipes
 
-6.4.  pl.set_pid
+5.4.  pl.set_pid
 
    Sets the PID Controller parameters for the Feedback Algorithm.
 
@@ -606,7 +491,7 @@ with unexpected retcode=$var(check_result)\n");
    RPC Command Format:
         kamcmd pl.set_pid 0.5 0.5 0.5
 
-6.5.  pl.get_pid
+5.5.  pl.get_pid
 
    Gets the list of in use PID Controller parameters.
 
@@ -617,7 +502,7 @@ with unexpected retcode=$var(check_result)\n");
    RPC Command Format:
         kamcmd pl.get_pid
 
-6.6.  pl.push_load
+5.6.  pl.push_load
 
    Force the value of the load parameter. This command is useful for
    testing the Feedback algorithm.
index 5b50d46..016d198 100644 (file)
@@ -55,16 +55,12 @@ Alexandr Dubovikov
               4.1. sip_capture([table])
               4.2. report_capture([table],[data])
 
-        5. MI Commands
+        5. RPC Commands
 
-              5.1. sip_capture
+              5.1. sipcapture.status param
 
-        6. RPC Commands
-
-              6.1. sipcapture.status param
-
-        7. Database setup
-        8. Limitations
+        6. Database setup
+        7. Limitations
 
    List of Examples
 
@@ -129,16 +125,12 @@ Chapter 1. Admin Guide
         4.1. sip_capture([table])
         4.2. report_capture([table],[data])
 
-   5. MI Commands
-
-        5.1. sip_capture
-
-   6. RPC Commands
+   5. RPC Commands
 
-        6.1. sipcapture.status param
+        5.1. sipcapture.status param
 
-   7. Database setup
-   8. Limitations
+   6. Database setup
+   7. Limitations
 
 1. Overview
 
@@ -513,33 +505,11 @@ report_capture("report_data");
 report_capture("report_data", "{\"MOS\":4.1,\"PACKET_LOST\":100"});
 ...
 
-5. MI Commands
-
-   5.1. sip_capture
-
-5.1.  sip_capture
-
-   Name: sip_capture
-
-   Parameters:
-     * capture_mode : turns on/off SIP message capturing. Possible values
-       are:
-          + on
-          + off
-       The parameter is optional - if missing, the command will return the
-       status of the SIP message capturing (as string “on” or “off” )
-       without changing anything.
-
-   MI FIFO Command Format:
-                :sip_capture:_reply_fifo_file_
-                capture_mode
-                _empty_line_
+5. RPC Commands
 
-6. RPC Commands
+   5.1. sipcapture.status param
 
-   6.1. sipcapture.status param
-
-6.1.  sipcapture.status param
+5.1.  sipcapture.status param
 
    Name: sipcapture.status
 
@@ -550,7 +520,14 @@ report_capture("report_data", "{\"MOS\":4.1,\"PACKET_LOST\":100"});
      * “check” does not change sipcapture status, just reports the current
        status.
 
-7. Database setup
+   RPC Command Format:
+...
+kamcmd sipcapture.status on
+kamcmd sipcapture.status off
+kamcmd sipcapture.status check
+...
+
+6. Database setup
 
    Before running Kamailio with the sipcapture module, you have to setup
    the database tables where the module will store the data. For that, if
@@ -560,7 +537,7 @@ report_capture("report_data", "{\"MOS\":4.1,\"PACKET_LOST\":100"});
    find the complete database documentation on the project webpage,
    http://www.kamailio.org/docs/db-tables/kamailio-db-devel.html.
 
-8. Limitations
+7. Limitations
 
      * 1. Only one capturing mode on RAW socket is supported: IPIP or
        monitoring/mirroring port. Don't activate both at the same time.
index eb6235f..1c9bec7 100644 (file)
@@ -56,16 +56,12 @@ Daniel-Constantin Mierla
 
               4.1. sip_trace([address])
 
-        5. MI Commands
+        5. RPC Commands
 
-              5.1. sip_trace
+              5.1. siptrace.status param
 
-        6. RPC Commands
-
-              6.1. siptrace.status param
-
-        7. Database setup
-        8. Known issues
+        6. Database setup
+        7. Known issues
 
    List of Examples
 
@@ -124,16 +120,12 @@ Chapter 1. Admin Guide
 
         4.1. sip_trace([address])
 
-   5. MI Commands
-
-        5.1. sip_trace
-
-   6. RPC Commands
+   5. RPC Commands
 
-        6.1. siptrace.status param
+        5.1. siptrace.status param
 
-   7. Database setup
-   8. Known issues
+   6. Database setup
+   7. Known issues
 
 1. Overview
 
@@ -465,32 +457,11 @@ sip_trace();
 sip_trace("sip:10.1.1.2:5085");
 ...
 
-5. MI Commands
-
-   5.1. sip_trace
-
-5.1.  sip_trace
-
-   Name: sip_trace
-
-   Parameters:
-     * trace_mode : turns on/off SIP message tracing. Possible values are:
-          + on
-          + off
-       The parameter is optional - if missing, the command will return the
-       status of the SIP message tracing (as string “on” or “off” )
-       without changing anything.
-
-   MI FIFO Command Format:
-                :sip_trace:_reply_fifo_file_
-                trace_mode
-                _empty_line_
+5. RPC Commands
 
-6. RPC Commands
+   5.1. siptrace.status param
 
-   6.1. siptrace.status param
-
-6.1.  siptrace.status param
+5.1.  siptrace.status param
 
    Name: siptrace.status
 
@@ -501,7 +472,14 @@ sip_trace("sip:10.1.1.2:5085");
      * “check” does not change siptrace status, just reports the current
        status.
 
-7. Database setup
+   RPC Command Format:
+...
+kamcmd siptrace.status on
+kamcmd siptrace.status off
+kamcmd siptrace.status check
+...
+
+6. Database setup
 
    Before running Kamailio with siptrace, you have to setup the database
    tables where the module will store the data. For that, if the table
@@ -511,7 +489,7 @@ sip_trace("sip:10.1.1.2:5085");
    You can also find the complete database documentation on the project
    webpage, http://www.kamailio.org/docs/db-tables/kamailio-db-devel.html.
 
-8. Known issues
+7. Known issues
 
    Stateless forwarded messages (forward()) are not logged if you set the
    flag, use sip_trace().