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

src/modules/async/README

@@ -241,13 +241,19 @@ route[RESUME] {
 4.3.  async_sleep(seconds)
 
    Simulate a sleep of 'seconds' and then continue the processing of SIP
-   request with the next action. In case of internal errors, the function
-   returns false.
+   request with the next action. Note that the processing continues till
+   the last action in the current route block. Consider using
+   async_route() instead if you want to control better what is executed
+   after the wait time. Beacuse the execution is resumed in another
+   process, do not use private memory variables before and after the async
+   sleep.
 
    The sleep parameter represent the number of seconds to suspend the
    processing of SIP request. Maximum value is 100. The parameter can be a
    static integer or a variable holding an integer.
 
+   In case of internal errors, the function returns false.
+
    This function can be used from REQUEST_ROUTE.
 
    Example 1.6. async_sleep usage
@@ -259,10 +265,9 @@ exit;
 
 4.4.  async_ms_sleep(milliseconds)
 
-   Simulate a sleep of 'milliseconds' and then continue the processing of
-   SIP request with the next action. In case of internal errors, the
-   function returns false. This function works only if the ms_timer
-   parameter has a value greater than 0.
+   Similar to async_sleep(), but with a 'milliseconds' parameter. This
+   function works only if the ms_timer parameter has a value greater than
+   0.
 
    The sleep parameter represent the number of milliseconds to suspend the
    processing of SIP request. Maximum value is 30000 (30 sec). The

src/modules/siptrace/README

@@ -61,10 +61,11 @@ Camille Oudot
               3.20. force_send_sock (str)
               3.21. trace_init_mode (integer)
               3.22. trace_mode (integer)
-              3.23. auth_key (integer)
-              3.24. evcb_msg (str)
-              3.25. trace_dialog_ack (str)
-              3.26. trace_dialog_spiral (str)
+              3.23. data_mode (integer)
+              3.24. auth_key (integer)
+              3.25. evcb_msg (str)
+              3.26. trace_dialog_ack (str)
+              3.27. trace_dialog_spiral (str)
 
         4. Functions
 
@@ -107,15 +108,16 @@ Camille Oudot
    1.19. Set send_sock_addr parameter
    1.20. Set trace_init_mode parameter
    1.21. Set trace_mode parameter
-   1.22. Set auth_key parameter
-   1.23. Set evcb_msg parameter
-   1.24. Set trace_dialog_ack parameter
-   1.25. Set trace_dialog_spiral parameter
-   1.26. sip_trace() usage
-   1.27. sip_trace_mode() usage
-   1.28. sip_trace_msg() usage
-   1.29. hlog() usage
-   1.30. Send relayed ACK message
+   1.22. Set data_mode parameter
+   1.23. Set auth_key parameter
+   1.24. Set evcb_msg parameter
+   1.25. Set trace_dialog_ack parameter
+   1.26. Set trace_dialog_spiral parameter
+   1.27. sip_trace() usage
+   1.28. sip_trace_mode() usage
+   1.29. sip_trace_msg() usage
+   1.30. hlog() usage
+   1.31. Send relayed ACK message
 
 Chapter 1. Admin Guide
 
@@ -151,10 +153,11 @@ Chapter 1. Admin Guide
         3.20. force_send_sock (str)
         3.21. trace_init_mode (integer)
         3.22. trace_mode (integer)
-        3.23. auth_key (integer)
-        3.24. evcb_msg (str)
-        3.25. trace_dialog_ack (str)
-        3.26. trace_dialog_spiral (str)
+        3.23. data_mode (integer)
+        3.24. auth_key (integer)
+        3.25. evcb_msg (str)
+        3.26. trace_dialog_ack (str)
+        3.27. trace_dialog_spiral (str)
 
    4. Functions
 
@@ -238,10 +241,11 @@ Chapter 1. Admin Guide
    3.20. force_send_sock (str)
    3.21. trace_init_mode (integer)
    3.22. trace_mode (integer)
-   3.23. auth_key (integer)
-   3.24. evcb_msg (str)
-   3.25. trace_dialog_ack (str)
-   3.26. trace_dialog_spiral (str)
+   3.23. data_mode (integer)
+   3.24. auth_key (integer)
+   3.25. evcb_msg (str)
+   3.26. trace_dialog_ack (str)
+   3.27. trace_dialog_spiral (str)
 
 3.1. db_url (str)
 
@@ -553,42 +557,55 @@ modparam("siptrace", "trace_mode", 1)
 modparam("siptrace", "trace_mode", 3)
 ...
 
-3.23. auth_key (integer)
+3.23. data_mode (integer)
+
+   A set of flags to control what data is used for the trace. If flag 1
+   (value 1) is set, then advertised address (when set) is used instead of
+   socket bind address.
+
+   Default value is 0.
+
+   Example 1.22. Set data_mode parameter
+...
+modparam("siptrace", "data_mode", 1)
+...
+
+3.24. auth_key (integer)
 
    A string with an authorization key. Supported on HEPv3 only.
 
    Default value is empty.
 
-   Example 1.22. Set auth_key parameter
+   Example 1.23. Set auth_key parameter
 ...
 modparam("siptrace", "auth_key", "spoihepuirthpeuia")
 ...
 
-3.24. evcb_msg (str)
+3.25. evcb_msg (str)
 
    Set the name of KEMI function to be executed instead of
    event_route[siptrace:msg].
 
    Default value is empty.
 
-   Example 1.23. Set evcb_msg parameter
+   Example 1.24. Set evcb_msg parameter
 ...
 modparam("siptrace", "evcb_msg", "ksr_siptrace_msg")
 ...
 
-3.25. trace_dialog_ack (str)
+3.26. trace_dialog_ack (str)
 
    Enable tracing of in-dialog ACK. Before this param, one must have set
    the onsend() route and captured the outgoing ACK there.
 
    Default value is 1 (enabled).
 
-   Example 1.24. Set trace_dialog_ack parameter
+   Example 1.25. Set trace_dialog_ack parameter
 ...
 modparam("siptrace", "trace_dialog_ack", 1)
 ...
 
-3.26. trace_dialog_spiral (str)
+3.27. trace_dialog_spiral (str)
 
    Enable tracing of dialog spirals. A spiraled dialog is a dialog
    established by a SIP INVITE that loops back to the same kamailio (as
@@ -597,7 +614,7 @@ modparam("siptrace", "trace_dialog_ack", 1)
 
    Default value is 1 (enabled).
 
-   Example 1.25. Set trace_dialog_spiral parameter
+   Example 1.26. Set trace_dialog_spiral parameter
 ...
 modparam("siptrace", "trace_dialog_spiral", 1)
 ...
@@ -633,7 +650,7 @@ modparam("siptrace", "trace_dialog_spiral", 1)
    ONREPLY_ROUTE, BRANCH_ROUTE.
    Default value is "NULL".
 
-   Example 1.26. sip_trace() usage
+   Example 1.27. sip_trace() usage
 ...
 sip_trace();
 ...
@@ -659,7 +676,7 @@ sip_trace("sip:10.1.1.2:5085", "$ci-abc", "d");
 
    This function can be used in ANY_ROUTE.
 
-   Example 1.27. sip_trace_mode() usage
+   Example 1.28. sip_trace_mode() usage
 ...
 sip_trace_mode("t");
 ...
@@ -674,7 +691,7 @@ sip_trace_mode("t");
 
    This function can be used in ANY_ROUTE.
 
-   Example 1.28. sip_trace_msg() usage
+   Example 1.29. sip_trace_msg() usage
 ...
 sip_trace_msg("$var(msg)", "udp:127.0.0.1:5062", "udp:127.0.0.1:5064", "sip:127.
 0.0.1:5090", "");
@@ -692,7 +709,7 @@ sip_trace_msg("$var(msg)", "udp:127.0.0.1:5062", "udp:127.0.0.1:5064", "sip:127.
      * message - The text to send to Homer as log event. (This parameter
        may contain PVs)
 
-   Example 1.29. hlog() usage
+   Example 1.30. hlog() usage
 ...
 hlog("[cfg:$cfg(line)] This is a log from kamailio to Homer");
 ...
@@ -766,7 +783,7 @@ event_route[siptrace:msg] {
    this name will result in overlapping internal avp used by the module
    therefore causing unknown consequences.
 
-   Example 1.30. Send relayed ACK message
+   Example 1.31. Send relayed ACK message
 ...
 onsend_route {
     if (is_method("ACK")) {

src/modules/siputils/README

@@ -36,6 +36,8 @@ Bogdan-Andrei Iancu
 
 Gabriel Vasile
 
+Eik Rentzow
+
    Copyright © 2008, 2005, 2003 1&1 Internet AG, FhG Fokus, Voice Sistem
    SRL
      __________________________________________________________________
@@ -113,6 +115,7 @@ Gabriel Vasile
               5.3. $pcv(genaddr)
               5.4. $pcv(orig)
               5.5. $pcv(term)
+              5.6. $pcv(status)
 
    List of Examples
 
@@ -240,6 +243,7 @@ Chapter 1. Admin Guide
         5.3. $pcv(genaddr)
         5.4. $pcv(orig)
         5.5. $pcv(term)
+        5.6. $pcv(status)
 
 1. Overview
 
@@ -1051,7 +1055,19 @@ if(is_first_hop("1")) { ... }
 4.35.  sip_p_charging_vector(flags)
 
    Manage the P-Charging-Vector header (RFC7315). The flags can be: 'r' -
-   remove; 'g' - generate; 'f' - force (remove + generate).
+   remove; 'g' - generate; 'f' - force (remove + generate). Once a new PCV
+   has been generated by 'g' or 'f' the PCV cannot be changed again. The
+   icid-generated-at parameter of a generated PCV will be set to the
+   sending interface.IP address.
+
+   Return Codes:
+     * 1 - Nothing was done.
+     * (2 - intentionally left out)
+     * 3 - P-Charging-Vector header has been newly generated.
+     * 4 - P-Charging-Vector header has been deleted.
+     * 5 - P-Charging-Vector header has been replaced or inserted after
+       deletion.
+     * negative - Any error occured during execution.
 
    This function can be used from ANY_ROUTE.
 
@@ -1176,6 +1192,7 @@ if (!hdr_date_check("10")) {
    5.3. $pcv(genaddr)
    5.4. $pcv(orig)
    5.5. $pcv(term)
+   5.6. $pcv(status)
 
 5.1. $pcv(all)
 
@@ -1196,3 +1213,16 @@ if (!hdr_date_check("10")) {
 5.5. $pcv(term)
 
    term-ioi field (see RFC7315 section 5.6)
+
+5.6. $pcv(status)
+
+   Returns whether the PCV header was successfully parsed, deleted, newly
+   generated or other.
+     * 0 - No P-Charging-Vector header in message.
+     * 1 - P-Charging-Vector header in message and parsed successfully.
+     * 2 - P-Charging-Vector is present, but has no valid icid-value
+       parameter.
+     * 3 - P-Charging-Vector header has been newly generated or replaced.
+     * 4 - P-Charging-Vector header has been deleted.
+
+   Negative values indicate an internal error during the parsing process.

src/modules/snmpstats/README

@@ -282,10 +282,11 @@ Chapter 1. Admin Guide
      * usrloc - all scalars and tables relating to users and contacts are
        dependent on the usrloc module. If the module is not loaded, the
        respective tables will be empty.
-     * dialog or dialog-ng - all scalars relating to the number of dialogs
-       are dependent on the presence of a dialog module. Furthermore, if
-       the module is not loaded, then the kamailioDialogLimitMinorEvent,
-       and kamailioDialogLimitMajorEvent alarm will be disabled.
+     * dialog or ims_dialog - all scalars relating to the number of
+       dialogs are dependent on the presence of a dialog module.
+       Furthermore, if the module is not loaded, then the
+       kamailioDialogLimitMinorEvent, and kamailioDialogLimitMajorEvent
+       alarm will be disabled.
 
    The contents of the kamailioSIPMethodSupportedTable change depending on
    which modules are loaded.

src/modules/sst/README

@@ -170,7 +170,7 @@ Chapter 1. Admin Guide
 3.1. Kamailio Modules
 
    The following modules must be loaded before this module:
-     * dialog or dialog-ng - dialog module and its dependencies. (tm)
+     * dialog or ims_dialog - dialog module and its dependencies. (tm)
      * sl - stateless module.
 
 3.2. External Libraries or Applications

src/modules/timer/README

@@ -183,14 +183,14 @@ if (@timer.executed != "") {
 
    Example 1.5. Common example using timer module
 ...
-loadmodule "modules/xprint/xprint.so"
-loadmodule "modules/timer/timer.so"
+loadmodule "xlog.so"
+loadmodule "timer.so"
 
 modparam("timer", "declare_timer", "tmr1=ONTIMER,1000");
 modparam("timer", "declare_timer", "tmr2=ONTIMER2,2000,slow,enable");
 
 route["print"] {
-        xplog("L_INFO", "fired: %@timer.executed\n");
+        xlog("fired: $sel(@timer.executed)\n");
 }
 
 route["ONTIMER"] {
@@ -227,20 +227,20 @@ end
    route section which is called once after Kamailio starts.
 ...
 loadmodule "timer";
-loadmodule "xprint";
+loadmodule "xlog";
 
 modparam("timer", "declare_timer", "TIMER_TEST=TEST,100,,enable");
 
 request_route {
-        xplog("L_E","main route");
+        xlog("main route");
 }
 
 route[TEST] {
         timer_enable("TIMER_TEST", "0");
-        xplog("L_E","test start\n");
+        xlog("test start\n");
 
         # add here tested functionality
 
-        xplog("L_E","test end\n");
-        }
+        xlog("test end\n");
+}
 ...