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

src/modules/ims_ipsec_pcscf/README

@@ -59,6 +59,8 @@ Tsvetomir Dimitrov
               4.1. ipsec_create(domain)
               4.2. ipsec_forward(domain, flags)
               4.3. ipsec_destroy(domain [, aor])
+              4.4. ipsec_destroy_by_contact(domain, aor, recv_host,
+                      recv_port)
 
    List of Examples
 
@@ -75,6 +77,7 @@ Tsvetomir Dimitrov
    1.11. ipsec_create
    1.12. ipsec_forward
    1.13. ipsec_destroy
+   1.14. ipsec_destroy_by_contact()
 
 Chapter 1. Admin Guide
 
@@ -104,6 +107,7 @@ Chapter 1. Admin Guide
         4.1. ipsec_create(domain)
         4.2. ipsec_forward(domain, flags)
         4.3. ipsec_destroy(domain [, aor])
+        4.4. ipsec_destroy_by_contact(domain, aor, recv_host, recv_port)
 
 1. Overview
 
@@ -271,6 +275,7 @@ modparam("ims_ipsec_pcscf", "ipsec_preferred_ealg", "aes-cbc")
    4.1. ipsec_create(domain)
    4.2. ipsec_forward(domain, flags)
    4.3. ipsec_destroy(domain [, aor])
+   4.4. ipsec_destroy_by_contact(domain, aor, recv_host, recv_port)
 
 4.1. ipsec_create(domain)
 
@@ -339,3 +344,22 @@ ipsec_forward("location", "1");
 ...
 ipsec_destroy("location");
 ...
+
+4.4. ipsec_destroy_by_contact(domain, aor, recv_host, recv_port)
+
+   The function destroys IPSec tunnel, created with ipsec_create.
+
+   Meaning of the parameters is as follows:
+     * domain - Logical domain within the registrar. If a database is used
+       then this must be name of the table which stores the contacts.
+       aor - SIP URI to match the record.
+       recv_host - received host to match the record.
+       recv_port - received port to match the record.
+
+   The last three parameters have to be string valies and can contain
+   variables.
+
+   Example 1.14. ipsec_destroy_by_contact()
+...
+ipsec_destroy_by_contact("location", "...", "...", "...");
+...

src/modules/ims_qos/README

@@ -65,6 +65,8 @@ Carsten Bock
               3.22. rs_default_bandwidth integer
               3.23. rr_default_bandwidth integer
               3.24. suspend_transaction integer
+              3.25. recv_mode integer
+              3.26. dialog_direction integer
 
         4. Functions
 
@@ -103,8 +105,10 @@ Carsten Bock
    1.22. rs_default_bandwidth parameter usage
    1.23. rr_default_bandwidth parameter usage
    1.24. suspend_transaction parameter usage
-   1.25. Rx_AAR_Register
-   1.26. Rx_AAR
+   1.25. recv_mode parameter usage
+   1.26. dialog_direction parameter usage
+   1.27. Rx_AAR_Register
+   1.28. Rx_AAR
 
 Chapter 1. Admin Guide
 
@@ -142,6 +146,8 @@ Chapter 1. Admin Guide
         3.22. rs_default_bandwidth integer
         3.23. rr_default_bandwidth integer
         3.24. suspend_transaction integer
+        3.25. recv_mode integer
+        3.26. dialog_direction integer
 
    4. Functions
 
@@ -206,6 +212,8 @@ Chapter 1. Admin Guide
    3.22. rs_default_bandwidth integer
    3.23. rr_default_bandwidth integer
    3.24. suspend_transaction integer
+   3.25. recv_mode integer
+   3.26. dialog_direction integer
 
 3.1. rx_dest_realm (string)
 
@@ -507,6 +515,32 @@ modparam("ims_qos", "rr_default_bandwidth", 2000)
 modparam("ims_qos", "suspend_transaction", 0)
 ...
 
+3.25. recv_mode integer
+
+   If set to 0, rx_aar_register() takes the received-from address values
+   (IP, port, proto) from the IP frame. If set to 1, it takes them from
+   Via header.
+
+   Default value is 0
+
+   Example 1.25. recv_mode parameter usage
+...
+modparam("ims_qos", "recv_mode", 1)
+...
+
+3.26. dialog_direction integer
+
+   If set to 1, DLG_MOBILE_ORIGINATING is set to
+   rx_add_media_component_description_avp() instead of DLG_MOBILE_REGISTER
+   (which corresponds to value 3).
+
+   Default value is 3
+
+   Example 1.26. dialog_direction parameter usage
+...
+modparam("ims_qos", "dialog_direction", 1)
+...
+
 4. Functions
 
    4.1. Rx_AAR_Register(route_block, domain)
@@ -537,7 +571,7 @@ modparam("ims_qos", "suspend_transaction", 0)
    p.s. this is executed asynchronously. See example on how to retrieve
    return value
 
-   Example 1.25. Rx_AAR_Register
+   Example 1.27. Rx_AAR_Register
 ...
 if(Rx_AAR_Register("REG_AAR_REPLY","location")==0){
     exit;
@@ -581,7 +615,7 @@ route[REG_AAR_REPLY]
    p.s. this is executed asynchronously. See example on how to retrieve
    return value
 
-   Example 1.26. Rx_AAR
+   Example 1.28. Rx_AAR
 ...
 if(Rx_AAR("ORIG_SESSION_AAR_REPLY","orig","",-1)==0){
     exit;

src/modules/ims_registrar_pcscf/README

@@ -50,6 +50,7 @@ Carsten Bock
               3.9. ignore_reg_state (int)
               3.10. force_icscf_uri (string)
               3.11. reginfo_queue_size_threshold (int)
+              3.12. delete_delay (int)
 
         4. Functions
 
@@ -72,7 +73,8 @@ Carsten Bock
    1.9. ignore_reg_state parameter usage
    1.10. force_icscf_uri parameter usage
    1.11. reginfo_queue_size_threshold parameter usage
-   1.12. pcscf_save
+   1.12. delete_delay parameter usage
+   1.13. pcscf_save
 
 Chapter 1. Admin Guide
 
@@ -97,6 +99,7 @@ Chapter 1. Admin Guide
         3.9. ignore_reg_state (int)
         3.10. force_icscf_uri (string)
         3.11. reginfo_queue_size_threshold (int)
+        3.12. delete_delay (int)
 
    4. Functions
 
@@ -139,6 +142,7 @@ Chapter 1. Admin Guide
    3.9. ignore_reg_state (int)
    3.10. force_icscf_uri (string)
    3.11. reginfo_queue_size_threshold (int)
+   3.12. delete_delay (int)
 
 3.1. pcscf_uri (string)
 
@@ -280,6 +284,18 @@ network.org")
 modparam("ims_registrar_pcscf", "reginfo_queue_size_threshold", 42)
 ...
 
+3.12. delete_delay (int)
+
+   If set greater than 0, the delete of a pcontact record is delayed with
+   its value instead of being done immediately.
+
+   Default value is 0 (delete immediately).
+
+   Example 1.12. delete_delay parameter usage
+...
+modparam("ims_registrar_pcscf", "delete_delay", 10)
+...
+
 4. Functions
 
    4.1. pcscf_save(domain)
@@ -298,7 +314,7 @@ modparam("ims_registrar_pcscf", "reginfo_queue_size_threshold", 42)
      * domain - Logical domain within the registrar. If a database is used
        then this must be name of the table which stores the contacts.
 
-   Example 1.12. pcscf_save
+   Example 1.13. pcscf_save
 ...
 pcscf_save("location");
 ...