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

src/modules/siptrace/README

@@ -55,10 +55,12 @@ Camille Oudot
               3.14. hep_version (integer)
               3.15. hep_capture_id (integer)
               3.16. trace_delayed (integer)
-              3.17. force_send_sock (str)
-              3.18. trace_init_mode (integer)
-              3.19. trace_mode (integer)
-              3.20. auth_key (integer)
+              3.17. send_sock_name (str)
+              3.18. send_sock_addr (str)
+              3.19. force_send_sock (str)
+              3.20. trace_init_mode (integer)
+              3.21. trace_mode (integer)
+              3.22. auth_key (integer)
 
         4. Functions
 
@@ -91,14 +93,15 @@ Camille Oudot
    1.14. Set hep_version parameter
    1.15. Set hep_capture_id parameter
    1.16. Set trace_delayed parameter
-   1.17. Set force_send_sock parameter
-   1.18. Set trace_init_mode parameter
-   1.19. Set trace_mode parameter
-   1.20. Set auth_key parameter
-   1.21. sip_trace() usage
-   1.22. sip_trace_mode() usage
-   1.23. hlog() usage
-   1.24. Send relayed ACK message
+   1.17. Set send_sock_name parameter
+   1.18. Set send_sock_addr parameter
+   1.19. Set trace_init_mode parameter
+   1.20. Set trace_mode parameter
+   1.21. Set auth_key parameter
+   1.22. sip_trace() usage
+   1.23. sip_trace_mode() usage
+   1.24. hlog() usage
+   1.25. Send relayed ACK message
 
 Chapter 1. Admin Guide
 
@@ -128,10 +131,12 @@ Chapter 1. Admin Guide
         3.14. hep_version (integer)
         3.15. hep_capture_id (integer)
         3.16. trace_delayed (integer)
-        3.17. force_send_sock (str)
-        3.18. trace_init_mode (integer)
-        3.19. trace_mode (integer)
-        3.20. auth_key (integer)
+        3.17. send_sock_name (str)
+        3.18. send_sock_addr (str)
+        3.19. force_send_sock (str)
+        3.20. trace_init_mode (integer)
+        3.21. trace_mode (integer)
+        3.22. auth_key (integer)
 
    4. Functions
 
@@ -204,10 +209,12 @@ Chapter 1. Admin Guide
    3.14. hep_version (integer)
    3.15. hep_capture_id (integer)
    3.16. trace_delayed (integer)
-   3.17. force_send_sock (str)
-   3.18. trace_init_mode (integer)
-   3.19. trace_mode (integer)
-   3.20. auth_key (integer)
+   3.17. send_sock_name (str)
+   3.18. send_sock_addr (str)
+   3.19. force_send_sock (str)
+   3.20. trace_init_mode (integer)
+   3.21. trace_mode (integer)
+   3.22. auth_key (integer)
 
 3.1. db_url (str)
 
@@ -426,18 +433,36 @@ modparam("siptrace", "hep_capture_id", 234)
 modparam("siptrace", "trace_delayed", 1)
 ...
 
-3.17. force_send_sock (str)
+3.17. send_sock_name (str)
+
+   The name of the local listen socket from where to send the duplicated
+   traffic via SIP or HEP. In the absence of this parameter Kamailio
+   automatically picks an interface. It has priority over 'send_sock_addr'
+   parameter.
+
+   Example 1.17. Set send_sock_name parameter
+...
+modparam("siptrace", "send_sock_name", "sock1")
+...
+
+3.18. send_sock_addr (str)
 
    The local interface in the form of SIP URI from where to send the
    duplicated traffic. In the absence of this parameter Kamailio
    automatically picks an interface.
 
-   Example 1.17. Set force_send_sock parameter
+   Example 1.18. Set send_sock_addr parameter
 ...
-modparam("siptrace", "force_send_sock", "sip:10.1.1.2:5000")
+modparam("siptrace", "send_sock_addr", "sip:10.1.1.2:5000")
 ...
 
-3.18. trace_init_mode (integer)
+3.19. force_send_sock (str)
+
+   It is the same as 'send_sock_addr' parameter, this being kept for
+   backward compatibility when 'send_sock_name' and 'send_sock_addr' were
+   introduced.
+
+3.20. trace_init_mode (integer)
 
    Control what tracing modes are initialized.
 
@@ -450,12 +475,12 @@ modparam("siptrace", "force_send_sock", "sip:10.1.1.2:5000")
 
    Default value is 0.
 
-   Example 1.18. Set trace_init_mode parameter
+   Example 1.19. Set trace_init_mode parameter
 ...
 modparam("siptrace", "trace_init_mode", 1)
 ...
 
-3.19. trace_mode (integer)
+3.21. trace_mode (integer)
 
    If not set to 0, the module uses core events triggered when receiving
    or sending SIP traffic to store it to database or mirror it to a SIP
@@ -476,7 +501,7 @@ modparam("siptrace", "trace_init_mode", 1)
 
    Default value is 0.
 
-   Example 1.19. Set trace_mode parameter
+   Example 1.20. Set trace_mode parameter
 ...
 modparam("siptrace", "trace_on", 1)
 modparam("siptrace", "trace_mode", 1)
@@ -484,13 +509,13 @@ modparam("siptrace", "trace_mode", 1)
 modparam("siptrace", "trace_mode", 3)
 ...
 
-3.20. auth_key (integer)
+3.22. auth_key (integer)
 
    A string with an authorization key. Supported on HEPv3 only.
 
    Default value is empty.
 
-   Example 1.20. Set auth_key parameter
+   Example 1.21. Set auth_key parameter
 ...
 modparam("siptrace", "auth_key", "spoihepuirthpeuia")
 ...
@@ -523,7 +548,7 @@ modparam("siptrace", "auth_key", "spoihepuirthpeuia")
    ONREPLY_ROUTE, BRANCH_ROUTE.
    Default value is "NULL".
 
-   Example 1.21. sip_trace() usage
+   Example 1.22. sip_trace() usage
 ...
 sip_trace();
 ...
@@ -549,7 +574,7 @@ sip_trace("sip:10.1.1.2:5085", "$ci-abc", "d");
 
    This function can be used in ANY_ROUTE.
 
-   Example 1.22. sip_trace_mode() usage
+   Example 1.23. sip_trace_mode() usage
 ...
 sip_trace_mode("t");
 ...
@@ -566,7 +591,7 @@ sip_trace_mode("t");
      * message - The text to send to Homer as log event. (This parameter
        may contain PVs)
 
-   Example 1.23. hlog() usage
+   Example 1.24. hlog() usage
 ...
 hlog("[cfg:$cfg(line)] This is a log from kamailio to Homer");
 ...
@@ -619,7 +644,7 @@ kamcmd siptrace.status check
    this name will result in overlapping internal avp used by the module
    therefore causing unknown consequences.
 
-   Example 1.24. Send relayed ACK message
+   Example 1.25. Send relayed ACK message
 ...
 onsend_route {
     if (is_method("ACK")) {