Sfoglia il codice sorgente

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

Kamailio Dev 5 anni fa
parent
commit
890ebc6f01
1 ha cambiato i file con 10 aggiunte e 4 eliminazioni
  1. 10 4
      src/modules/nathelper/README

+ 10 - 4
src/modules/nathelper/README

@@ -67,7 +67,7 @@ Ovidiu Sas
               5.6. is_rfc1918(ip_address)
               5.6. is_rfc1918(ip_address)
               5.7. add_contact_alias([ip_addr, port, proto])
               5.7. add_contact_alias([ip_addr, port, proto])
               5.8. handle_ruri_alias()
               5.8. handle_ruri_alias()
-              5.9. set_contact_alias()
+              5.9. set_contact_alias([trim])
               5.10. set_alias_to_pv(target_avp)
               5.10. set_alias_to_pv(target_avp)
 
 
         6. Exported Pseudo Variables
         6. Exported Pseudo Variables
@@ -158,7 +158,7 @@ Chapter 1. Admin Guide
         5.6. is_rfc1918(ip_address)
         5.6. is_rfc1918(ip_address)
         5.7. add_contact_alias([ip_addr, port, proto])
         5.7. add_contact_alias([ip_addr, port, proto])
         5.8. handle_ruri_alias()
         5.8. handle_ruri_alias()
-        5.9. set_contact_alias()
+        5.9. set_contact_alias([trim])
         5.10. set_alias_to_pv(target_avp)
         5.10. set_alias_to_pv(target_avp)
 
 
    6. Exported Pseudo Variables
    6. Exported Pseudo Variables
@@ -498,7 +498,7 @@ modparam("nathelper", "nat_addr_mode", 0)
    5.6. is_rfc1918(ip_address)
    5.6. is_rfc1918(ip_address)
    5.7. add_contact_alias([ip_addr, port, proto])
    5.7. add_contact_alias([ip_addr, port, proto])
    5.8. handle_ruri_alias()
    5.8. handle_ruri_alias()
-   5.9. set_contact_alias()
+   5.9. set_contact_alias([trim])
    5.10. set_alias_to_pv(target_avp)
    5.10. set_alias_to_pv(target_avp)
 
 
 5.1.  fix_nated_contact()
 5.1.  fix_nated_contact()
@@ -700,13 +700,19 @@ if(is_rfc1918("$rd")) {
     };
     };
 ...
 ...
 
 
-5.9.  set_contact_alias()
+5.9.  set_contact_alias([trim])
 
 
    Adds an “;alias=ip~port~transport” parameter to the contact URI
    Adds an “;alias=ip~port~transport” parameter to the contact URI
    containing the received ip, port, and transport protocol. The new
    containing the received ip, port, and transport protocol. The new
    contact URI is immediately visible to other modules in the way the
    contact URI is immediately visible to other modules in the way the
    fix_nated_contact() does it.
    fix_nated_contact() does it.
 
 
+   Meaning of parameters:
+     * trim - by default, set_contact_alias() will not detect and trim an
+       already existing alias parameter. If this optional parameter is set
+       to "1", set_contact_alias() will trim the existing alias before
+       adding a new one.
+
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
    BRANCH_ROUTE, and FAILURE_ROUTE.
    BRANCH_ROUTE, and FAILURE_ROUTE.