modules: readme files regenerated - sipcapture ... [skip ci]
[sip-router] / src / modules / sipcapture / README
index cd92cd5..bc7bc66 100644 (file)
@@ -49,23 +49,19 @@ Alexandr Dubovikov
               3.18. insert_retry_timeout (integer)
               3.19. callid_aleg_header (str)
               3.20. topoh_unmask (int)
+              3.21. nonsip_hook (int)
 
         4. Functions
 
               4.1. sip_capture([table])
               4.2. report_capture([table],[data])
 
-        5. Exported pseudo-variables
+        5. RPC Commands
 
-              5.1. $hep(src_ip)
-              5.2. $hep(dst_ip)
+              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
 
@@ -89,8 +85,9 @@ Alexandr Dubovikov
    1.18. Set insert_retry_timeout parameter
    1.19. Set callid_aleg_header parameter
    1.20. Set topoh_unmask parameter
-   1.21. sip_capture() usage
-   1.22. report_capture() usage
+   1.21. Set nonsip_hook parameter
+   1.22. sip_capture() usage
+   1.23. report_capture() usage
 
 Chapter 1. Admin Guide
 
@@ -124,22 +121,19 @@ Chapter 1. Admin Guide
         3.18. insert_retry_timeout (integer)
         3.19. callid_aleg_header (str)
         3.20. topoh_unmask (int)
+        3.21. nonsip_hook (int)
 
    4. Functions
 
         4.1. sip_capture([table])
         4.2. report_capture([table],[data])
 
-   5. Exported pseudo-variables
-        5.1. $hep(src_ip)
-        5.2. $hep(dst_ip)
-
-   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
 
@@ -195,6 +189,7 @@ Chapter 1. Admin Guide
    3.18. insert_retry_timeout (integer)
    3.19. callid_aleg_header (str)
    3.20. topoh_unmask (int)
+   3.21. nonsip_hook (int)
 
 3.1. db_url (str)
 
@@ -465,6 +460,18 @@ modparam("sipcapture", "callid_aleg_header", "X-CallIDALeg")
 modparam("sipcapture", "topoh_unmask", 1)
 ...
 
+3.21. nonsip_hook (int)
+
+   If set to 1, event route sipcapture:siprequest is run when HEP message
+   is received.
+
+   Default value is 0.
+
+   Example 1.21. Set nonsip_hook parameter
+...
+modparam("sipcapture", "nonsip_hook", 1)
+...
+
 4. Functions
 
    4.1. sip_capture([table])
@@ -486,7 +493,7 @@ modparam("sipcapture", "topoh_unmask", 1)
    ONREPLY_ROUTE, BRANCH_ROUTE.
    Default value is "NULL".
 
-   Example 1.21. sip_capture() usage
+   Example 1.22. sip_capture() usage
 ...
 sip_capture();
 ...
@@ -505,7 +512,7 @@ sip_capture("sip_capture_call_20160124");
    ONREPLY_ROUTE, BRANCH_ROUTE.
    Default value is "NULL".
 
-   Example 1.22. report_capture() usage
+   Example 1.23. report_capture() usage
 ...
 report_capture();
 ...
@@ -514,26 +521,11 @@ report_capture("report_data");
 report_capture("report_data", "{\"MOS\":4.1,\"PACKET_LOST\":100"});
 ...
 
-5. Exported pseudo-variables
-
-   5.1. $hep(src_ip)
-   5.2. $hep(dst_ip)
-
-   Exported pseudo-variables are listed in the next sections.
-
-5.1. $hep(src_ip)
-
-   Returns the current HEP's message original source IP address.
-
-5.2. $hep(dst_ip)
-
-   Returns the current HEP's message original destination IP address.
-
-6. RPC Commands
+5. RPC Commands
 
-   6.1. sipcapture.status param
+   5.1. sipcapture.status param
 
-6.1.  sipcapture.status param
+5.1.  sipcapture.status param
 
    Name: sipcapture.status
 
@@ -551,7 +543,7 @@ kamcmd sipcapture.status off
 kamcmd sipcapture.status check
 ...
 
-7. Database setup
+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
@@ -559,9 +551,9 @@ kamcmd sipcapture.status check
    install everything by yourself you can use the homer_databases.sql, SQL
    script in the sql folder of sipcapture module as template. You can also
    find the complete database documentation on the project webpage,
-   http://www.kamailio.org/docs/db-tables/kamailio-db-devel.html.
+   https://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.