modules: readme files regenerated - acc_radius ...

modules/acc_radius/README

@@ -211,7 +211,10 @@ modparam("acc_radius", "rad_time_mode", 1)
    “radius_config”.
 
    Meaning of the parameters is as follows:
-     * comment - Comment to be appended.
+     * comment - Comment to be appended. The first token can be a SIP
+       response code that it is wanted to be interpreted as event type
+       (e.g., using 200 means the transaction is considered successfully
+       responded).
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
@@ -219,5 +222,6 @@ modparam("acc_radius", "rad_time_mode", 1)
 ...
 acc_rad_request("Some comment");
 ...
+# write record as when the transaction was responded with a 200 code
 acc_rad_request("200 From Config");
 ...

modules/http_async_client/README

@@ -576,6 +576,20 @@ xlog("L_INFO", "received reply for query $http_query_id\n");
        http_set_tls_client_key())
      * tls_ca_path: sets the CA certificate path to use (see
        http_set_tls_ca_path())
+     * authmethod: Sets the preferred authentication mode for HTTP/HTTPS
+       requests. The value is a bitmap and multiple methods can be used.
+       Note that in this case, the CURL library will make an extra request
+       to discover server-supported authentication methods. You may want
+       to use a specific value.
+       Valid values are:
+          + 1 - BASIC authentication
+          + 2 - HTTP Digest authentication
+          + 4 - GSS-Negotiate authentication
+          + 8 - NTLM authentication
+          + 16 - HTTP Digest with IE flavour
+       Default value is 3 - BASIC and Digest authentication.
+     * username: sets the username to use for authenticated requests
+     * password: sets the password to use for authenticated requests
      * suspend: if set to 0 it doesn't suspend the current transaction
        before performing the query (see http_async_suspend())
 

modules/ims_qos/README

@@ -56,6 +56,7 @@ Carsten Bock
               3.13. regex_sdp_ip_prefix_to_maintain_in_fd (String)
               3.14. terminate_dialog_on_rx_failure integer
               3.15. delete_contact_on_rx_failure integer
+              3.16. include_rtcp_fd integer
 
         4. Functions
 
@@ -85,8 +86,9 @@ Carsten Bock
    1.13. regex_sdp_ip_prefix_to_maintain_in_fd parameter usage
    1.14. terminate_dialog_on_rx_failure parameter usage
    1.15. delete_contact_on_rx_failure parameter usage
-   1.16. Rx_AAR_Register
-   1.17. Rx_AAR
+   1.16. include_rtcp_fd parameter usage
+   1.17. Rx_AAR_Register
+   1.18. Rx_AAR
 
 Chapter 1. Admin Guide
 
@@ -115,6 +117,7 @@ Chapter 1. Admin Guide
         3.13. regex_sdp_ip_prefix_to_maintain_in_fd (String)
         3.14. terminate_dialog_on_rx_failure integer
         3.15. delete_contact_on_rx_failure integer
+        3.16. include_rtcp_fd integer
 
    4. Functions
 
@@ -170,6 +173,7 @@ Chapter 1. Admin Guide
    3.13. regex_sdp_ip_prefix_to_maintain_in_fd (String)
    3.14. terminate_dialog_on_rx_failure integer
    3.15. delete_contact_on_rx_failure integer
+   3.16. include_rtcp_fd integer
 
 3.1. rx_dest_realm (string)
 
@@ -367,6 +371,18 @@ modparam("ims_qos", "terminate_dialog_on_rx_failure", 0)
 modparam("ims_qos", "delete_contact_on_rx_failure", 0)
 ...
 
+3.16. include_rtcp_fd integer
+
+   If set then a flow description is added for media flows - next
+   available odd port is used as the default for RTCP traffic
+
+   Default value is 0, RTCP flow description not added
+
+   Example 1.16. include_rtcp_fd parameter usage
+...
+modparam("ims_qos", "include_rtcp_fd", 1)
+...
+
 4. Functions
 
    4.1. Rx_AAR_Register(route_block, domain)
@@ -397,7 +413,7 @@ modparam("ims_qos", "delete_contact_on_rx_failure", 0)
    p.s. this is executed asynchronously. See example on how to retrieve
    return value
 
-   Example 1.16. Rx_AAR_Register
+   Example 1.17. Rx_AAR_Register
 ...
 if(Rx_AAR_Register("REG_AAR_REPLY","location")==0){
     exit;
@@ -439,7 +455,7 @@ route[REG_AAR_REPLY]
    p.s. this is executed asynchronously. See example on how to retrieve
    return value
 
-   Example 1.17. Rx_AAR
+   Example 1.18. Rx_AAR
 ...
 if(Rx_AAR("ORIG_SESSION_AAR_REPLY","orig","",-1)==0){
     exit;

modules/ims_usrloc_pcscf/README

@@ -30,8 +30,7 @@ Richard Good
               3.3. db_url (int)
               3.4. db_mode (int)
               3.5. hashing_type (int)
-              3.6. lookup_check_received (int)
-              3.7. match_contact_host_port (int)
+              3.6. match_contact_host_port (int)
 
         4. RPC Commands
 
@@ -52,8 +51,7 @@ Richard Good
    1.3. Set db_url parameter
    1.4. Set db_mode parameter
    1.5. Set hashing_type parameter
-   1.6. Set lookup_check_received parameter
-   1.7. Set match_contact_host_port parameter
+   1.6. Set match_contact_host_port parameter
 
 Chapter 1. Admin Guide
 
@@ -72,8 +70,7 @@ Chapter 1. Admin Guide
         3.3. db_url (int)
         3.4. db_mode (int)
         3.5. hashing_type (int)
-        3.6. lookup_check_received (int)
-        3.7. match_contact_host_port (int)
+        3.6. match_contact_host_port (int)
 
    4. RPC Commands
 
@@ -124,8 +121,7 @@ Chapter 1. Admin Guide
    3.3. db_url (int)
    3.4. db_mode (int)
    3.5. hashing_type (int)
-   3.6. lookup_check_received (int)
-   3.7. match_contact_host_port (int)
+   3.6. match_contact_host_port (int)
 
 3.1. hash_size (int)
 
@@ -221,21 +217,7 @@ modparam("ims_usrloc_pcscf", "db_mode", 1)
 modparam("ims_usrloc_pcscf", "hashing_type", 1)
 ...
 
-3.6. lookup_check_received (int)
-
-   If set to 1 (default), the Host in the contact will be checked against
-   the Host, from which the request was received.
-     * 0 - Upon lookup, do not check the host against received.
-     * 1 - Compare the host in the contact against the received info.
-
-   Default value is 1.
-
-   Example 1.6. Set lookup_check_received parameter
-...
-modparam("ims_usrloc_pcscf", "lookup_check_received", 0)
-...
-
-3.7. match_contact_host_port (int)
+3.6. match_contact_host_port (int)
 
    If set to 1 (default), the contact is matched using only host and port
    in the contact URI.
@@ -245,7 +227,7 @@ modparam("ims_usrloc_pcscf", "lookup_check_received", 0)
 
    Default value is 1.
 
-   Example 1.7. Set match_contact_host_port parameter
+   Example 1.6. Set match_contact_host_port parameter
 ...
 modparam("ims_usrloc_pcscf", "match_contact_host_port", 0)
 ...

modules/nsq/README

@@ -42,6 +42,7 @@ Emmanuel Schmidbauer
               4.10. topic_channel(str)
               4.11. db_url(str)
               4.12. presentity_table(str)
+              4.13. db_table_lock_type(int)
 
         5. Functions
 
@@ -65,8 +66,9 @@ Emmanuel Schmidbauer
    1.11. Set topic_channel parameter
    1.12. Set db_url parameter
    1.13. Set presentity_table parameter
-   1.14. nsq_pua_publish usage
-   1.15. nsq.json usage
+   1.14. Set db_table_lock_type parameter
+   1.15. nsq_pua_publish usage
+   1.16. nsq.json usage
 
 Chapter 1. Admin Guide
 
@@ -97,6 +99,7 @@ Chapter 1. Admin Guide
         4.10. topic_channel(str)
         4.11. db_url(str)
         4.12. presentity_table(str)
+        4.13. db_table_lock_type(int)
 
    5. Functions
 
@@ -232,6 +235,7 @@ event_route[nsq:consumer-event]
    4.10. topic_channel(str)
    4.11. db_url(str)
    4.12. presentity_table(str)
+   4.13. db_table_lock_type(int)
 
 4.1. lookupd_address(str)
 
@@ -397,6 +401,17 @@ modparam("nsq", "db_url", "mysql://kamailio:kamailiorw@localhost/kamailio")
 modparam("nsq", "presentity_table", "my_presentity_table")
 ...
 
+4.13. db_table_lock_type(int)
+
+   Enable (=1) or disable (=0) the locks for table during a transaction.
+
+   Default value is “1”.
+
+   Example 1.14. Set db_table_lock_type parameter
+...
+modparam("nsq", "db_table_lock_type", 0)
+...
+
 5. Functions
 
    5.1. nsq_pua_publish(json_payload)
@@ -410,7 +425,7 @@ modparam("nsq", "presentity_table", "my_presentity_table")
 
    This function can be used from ANY ROUTE.
 
-   Example 1.14. nsq_pua_publish usage
+   Example 1.15. nsq_pua_publish usage
 ...
 event_route[nsq:consumer-event-presence-update]
 {
@@ -430,7 +445,7 @@ ackage})", 1);
 
    The prefix for nsq transformations is nsq.
      * json
-       Example 1.15. nsq.json usage
+       Example 1.16. nsq.json usage
 ...
 $var(Custom-Data) = $(nsqE{nsq.json,Custom-Data});
 if($var(Custom-Data) != $null) {

modules/rtpengine/README

@@ -337,6 +337,10 @@ modparam("rtpengine", "rtpengine_sock",
 
    Default value is “60”.
 
+   Can be set at runtime, e.g.:
+                        $ kamcmd cfg.set_now_int rtpengine rtpengine_disable_tou
+t 20
+
    Example 1.2. Set rtpengine_disable_tout parameter
 ...
 modparam("rtpengine", "rtpengine_disable_tout", 20)
@@ -349,6 +353,10 @@ modparam("rtpengine", "rtpengine_disable_tout", 20)
 
    Default value is “1000”.
 
+   Can be set at runtime, e.g.:
+                        $ kamcmd cfg.set_now_int rtpengine rtpengine_tout_ms 100
+0
+
    Example 1.3. Set rtpengine_tout_ms parameter
 ...
 modparam("rtpengine", "rtpengine_tout_ms", 2000)
@@ -382,11 +390,14 @@ modparam("rtpengine", "rtpengine_allow_op", 1)
    The total number of nodes inside a set (sets are configurable via
    rtpengine_sock function) to be queried before giving up establishing a
    session. This brings more flexibility in case checking all rtpengines
-   would take too long. Max limit is 50.
+   would take too long. Max limit is 30.
 
    By default all nodes in a set are tried before giving up communicating
    with the rtpengines.
 
+   Can be set at runtime, e.g.:
+                        $ kamcmd cfg.set_now_int rtpengine queried_nodes_limit 5
+
    Example 1.5. Set queried_nodes_limit parameter
 ...
 modparam("rtpengine", "queried_nodes_limit", 5)
@@ -399,6 +410,9 @@ modparam("rtpengine", "queried_nodes_limit", 5)
 
    Default value is “5”.
 
+   Can be set at runtime, e.g.:
+                        $ kamcmd cfg.set_now_int rtpengine rtpengine_retr 5
+
    Example 1.6. Set rtpengine_retr parameter
 ...
 modparam("rtpengine", "rtpengine_retr", 2)

modules/sdpops/README

@@ -28,7 +28,7 @@ Daniel-Constantin Mierla
 
               4.1. sdp_remove_codecs_by_id(list [, mtype])
               4.2. sdp_remove_codecs_by_name(list [, mtype])
-              4.3. sdp_remove_line_by_prefix(string)
+              4.3. sdp_remove_line_by_prefix(string [, mtype])
               4.4. sdp_keep_codecs_by_id(list [, mtype])
               4.5. sdp_keep_codecs_by_name(list [, mtype])
               4.6. sdp_with_media(type)
@@ -83,7 +83,7 @@ Chapter 1. Admin Guide
 
         4.1. sdp_remove_codecs_by_id(list [, mtype])
         4.2. sdp_remove_codecs_by_name(list [, mtype])
-        4.3. sdp_remove_line_by_prefix(string)
+        4.3. sdp_remove_line_by_prefix(string [, mtype])
         4.4. sdp_keep_codecs_by_id(list [, mtype])
         4.5. sdp_keep_codecs_by_name(list [, mtype])
         4.6. sdp_with_media(type)
@@ -135,7 +135,7 @@ Chapter 1. Admin Guide
 
    4.1. sdp_remove_codecs_by_id(list [, mtype])
    4.2. sdp_remove_codecs_by_name(list [, mtype])
-   4.3. sdp_remove_line_by_prefix(string)
+   4.3. sdp_remove_line_by_prefix(string [, mtype])
    4.4. sdp_keep_codecs_by_id(list [, mtype])
    4.5. sdp_keep_codecs_by_name(list [, mtype])
    4.6. sdp_with_media(type)
@@ -192,7 +192,7 @@ sdp_remove_codecs_by_name("PCMU");
 sdp_remove_codecs_by_name("PCMU,PCMA,GSM");
 ...
 
-4.3.  sdp_remove_line_by_prefix(string)
+4.3.  sdp_remove_line_by_prefix(string [, mtype])
 
    Remove all SDP attribute lines beginning with 'string' in all media
    streams.

modules/ss7ops/README

@@ -21,11 +21,15 @@ Holger Freyther
         2. External Libraries or Applications
         3. Functions
 
-              3.1. isup (integer)
+              3.1. isup_to_json
 
-        4. Parameters
+        4. Variables
 
-              4.1. isup_to_json (integer)
+              4.1. isup(id)
+
+   List of Examples
+
+   1.1. isup_to_json usage
 
 Chapter 1. Admin Guide
 
@@ -35,11 +39,11 @@ Chapter 1. Admin Guide
    2. External Libraries or Applications
    3. Functions
 
-        3.1. isup (integer)
+        3.1. isup_to_json
 
-   4. Parameters
+   4. Variables
 
-        4.1. isup_to_json (integer)
+        4.1. isup(id)
 
 1. Overview
 
@@ -55,19 +59,26 @@ Chapter 1. Admin Guide
 
 3. Functions
 
-   3.1. isup (integer)
+   3.1. isup_to_json
+
+3.1. isup_to_json
+
+   isup_to_json(proto)
 
-3.1. isup (integer)
+   Pass the HEP protocol type as parameter (e.g. 8 for M2UA) and the
+   contained ISUP payload will be converted to a JSON string. The result
+   can be accessed using the $isup(1) variable.
 
-   If set to 1, return the JSON representation as string for the last
-   message that was parsed.
+   Example 1.1. isup_to_json usage
+...
+isup_to_json(8);
+...
 
-4. Parameters
+4. Variables
 
-   4.1. isup_to_json (integer)
+   4.1. isup(id)
 
-4.1. isup_to_json (integer)
+4.1. isup(id)
 
-   Pass the HEP type as parameter (e.g. 8 for M2UA) and the contained ISUP
-   payload will be converted to a JSON string. It can be consumed using
-   the $isup(1) parameter.
+   If id is set to 1, return the JSON representation as string for the
+   last message that was parsed.