modules: readme files regenerated - sipdump ... [skip ci]

src/modules/sipdump/README

@@ -26,10 +26,12 @@ Daniel-Constantin Mierla
         3. Parameters
 
               3.1. enable (int)
-              3.2. wait (int)
-              3.3. rotate (int)
-              3.4. folder (str)
-              3.5. fprefix (str)
+              3.2. mode (int)
+              3.3. wait (int)
+              3.4. rotate (int)
+              3.5. folder (str)
+              3.6. fprefix (str)
+              3.7. event_callback (str)
 
         4. Functions
 
@@ -39,15 +41,21 @@ Daniel-Constantin Mierla
 
               5.1. sipdump.enable
 
+        6. Event Routes
+
+              6.1. sipdump:msg
+
    List of Examples
 
    1.1. Set enable parameter
-   1.2. Set wait parameter
-   1.3. Set rotate parameter
-   1.4. Set folder parameter
-   1.5. Set fprefix parameter
-   1.6. sipdump_send usage
-   1.7. sipdump.enable usage
+   1.2. Set mode parameter
+   1.3. Set wait parameter
+   1.4. Set rotate parameter
+   1.5. Set folder parameter
+   1.6. Set fprefix parameter
+   1.7. Set event_callback parameter
+   1.8. sipdump_send usage
+   1.9. sipdump.enable usage
 
 Chapter 1. Admin Guide
 
@@ -62,10 +70,12 @@ Chapter 1. Admin Guide
    3. Parameters
 
         3.1. enable (int)
-        3.2. wait (int)
-        3.3. rotate (int)
-        3.4. folder (str)
-        3.5. fprefix (str)
+        3.2. mode (int)
+        3.3. wait (int)
+        3.4. rotate (int)
+        3.5. folder (str)
+        3.6. fprefix (str)
+        3.7. event_callback (str)
 
    4. Functions
 
@@ -75,6 +85,10 @@ Chapter 1. Admin Guide
 
         5.1. sipdump.enable
 
+   6. Event Routes
+
+        6.1. sipdump:msg
+
 1. Overview
 
    This module writes SIP traffic and some associated details into local
@@ -115,14 +129,16 @@ Chapter 1. Admin Guide
 3. Parameters
 
    3.1. enable (int)
-   3.2. wait (int)
-   3.3. rotate (int)
-   3.4. folder (str)
-   3.5. fprefix (str)
+   3.2. mode (int)
+   3.3. wait (int)
+   3.4. rotate (int)
+   3.5. folder (str)
+   3.6. fprefix (str)
+   3.7. event_callback (str)
 
 3.1. enable (int)
 
-   Enable storage.
+   Enable sipdump activity.
 
    Default value is 0 (0 - off; 1 - on).
 
@@ -131,51 +147,80 @@ Chapter 1. Admin Guide
 modparam("sipdump", "enable", 1)
 ...
 
-3.2. wait (int)
+3.2. mode (int)
+
+   Set the type of activity done by the module, the value can be set based
+   on flags: 1 - write to files; 2 - execute event route
+
+   Default value is 1 (write to files).
+
+   Example 1.2. Set mode parameter
+...
+modparam("sipdump", "mode", 3)
+...
+
+3.3. wait (int)
 
    Wait time (microseconds) when no SIP traffic is received.
 
    Default value is 100.
 
-   Example 1.2. Set wait parameter
+   Example 1.3. Set wait parameter
 ...
 modparam("sipdump", "wait", 2000)
 ...
 
-3.3. rotate (int)
+3.4. rotate (int)
 
    Time interval in seconds to rotate files.
 
    Default value is 7200 (2 hours).
 
-   Example 1.3. Set rotate parameter
+   Example 1.4. Set rotate parameter
 ...
 modparam("sipdump", "rotate", 3600)
 ...
 
-3.4. folder (str)
+3.5. folder (str)
 
    Path to the folder where to save the files.
 
    Default value is "/tmp".
 
-   Example 1.4. Set folder parameter
+   Example 1.5. Set folder parameter
 ...
 modparam("sipdump", "folder", "/run/kamailio")
 ...
 
-3.5. fprefix (str)
+3.6. fprefix (str)
 
    File name prefix. The date is appended to this prefix in the format
    yyyy-mm-dd--hh-mm-ss. The extension of the file is ".data".
 
    Default value is "kamailio-sipdump-".
 
-   Example 1.5. Set fprefix parameter
+   Example 1.6. Set fprefix parameter
 ...
 modparam("sipdump", "fprefix", "ksipdump-")
 ...
 
+3.7. event_callback (str)
+
+   Name of the KEMI function to be executed instead of the event route.
+
+   Default value is not set.
+
+   Example 1.7. Set event_callback parameter
+...
+modparam("sipdump", "event_callback", "ksr_sipdump_event")
+...
+-- event callback function implemented in Lua
+function ksr_sipdump_event(evname)
+        KSR.info("===== sipdump module triggered event: " .. evname .. "\n");
+        return 1;
+end
+...
+
 4. Functions
 
    4.1. sipdump_send(tag)
@@ -190,7 +235,7 @@ modparam("sipdump", "fprefix", "ksipdump-")
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.6. sipdump_send usage
+   Example 1.8. sipdump_send usage
 ...
 sipdump_send("cfg");
 ...
@@ -208,9 +253,23 @@ sipdump_send("cfg");
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.7. sipdump.enable usage
+   Example 1.9. sipdump.enable usage
 ...
 kamcmd sipdump.enable
 kamcmd sipdump.enable 1
 kamcmd sipdump.enable 0
 ...
+
+6. Event Routes
+
+   6.1. sipdump:msg
+
+6.1.  sipdump:msg
+
+   Executed when sipdump handles messages and mode parameter has flag 2
+   set. The variable $sipdump(...) is available inside the event route.
+...
+event_route[sipdump:msg] {
+    xinfo("[$sipdump(tag)] [[$sipdump(buf)]]\n");
+}
+...