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

src/modules/nathelper/README

@@ -53,10 +53,11 @@ Ovidiu Sas
               4.11. nortpproxy_str (string)
               4.12. keepalive_timeout (int)
               4.13. udpping_from_path (int)
-              4.14. append_sdp_oldmediaip (int)
-              4.15. filter_server_id (int)
-              4.16. nat_addr_mode (int)
-              4.17. alias_name (string)
+              4.14. ignore_path (int)
+              4.15. append_sdp_oldmediaip (int)
+              4.16. filter_server_id (int)
+              4.17. nat_addr_mode (int)
+              4.18. alias_name (string)
 
         5. Functions
 
@@ -101,24 +102,25 @@ Ovidiu Sas
    1.11. Set nortpproxy_str parameter
    1.12. Set keepalive_timeout parameter
    1.13. Set udpping_from_path parameter
-   1.14. Set append_sdp_oldmediaip parameter
-   1.15. Set filter_server_id parameter
-   1.16. Set nat_addr_mode parameter
-   1.17. Set alias_name parameter
-   1.18. fix_nated_contact usage
-   1.19. fix_nated_sdp usage
-   1.20. add_rcv_param usage
-   1.21. fix_nated_register usage
-   1.22. nat_uac_test usage
-   1.23. is_rfc1918 usage
-   1.24. add_contact_alias usage
-   1.25. handle_ruri_alias usage
-   1.26. set_contact_alias usage
-   1.27. set_alias_to_pv usage
-   1.28. $rr_count usage
-   1.29. $rr_top_count usage
-   1.30. nathelper.enable_ping usage
-   1.31. @nathelper.rewrite_contact usage
+   1.14. Set ignore_path parameter
+   1.15. Set append_sdp_oldmediaip parameter
+   1.16. Set filter_server_id parameter
+   1.17. Set nat_addr_mode parameter
+   1.18. Set alias_name parameter
+   1.19. fix_nated_contact usage
+   1.20. fix_nated_sdp usage
+   1.21. add_rcv_param usage
+   1.22. fix_nated_register usage
+   1.23. nat_uac_test usage
+   1.24. is_rfc1918 usage
+   1.25. add_contact_alias usage
+   1.26. handle_ruri_alias usage
+   1.27. set_contact_alias usage
+   1.28. set_alias_to_pv usage
+   1.29. $rr_count usage
+   1.30. $rr_top_count usage
+   1.31. nathelper.enable_ping usage
+   1.32. @nathelper.rewrite_contact usage
 
 Chapter 1. Admin Guide
 
@@ -146,10 +148,11 @@ Chapter 1. Admin Guide
         4.11. nortpproxy_str (string)
         4.12. keepalive_timeout (int)
         4.13. udpping_from_path (int)
-        4.14. append_sdp_oldmediaip (int)
-        4.15. filter_server_id (int)
-        4.16. nat_addr_mode (int)
-        4.17. alias_name (string)
+        4.14. ignore_path (int)
+        4.15. append_sdp_oldmediaip (int)
+        4.16. filter_server_id (int)
+        4.17. nat_addr_mode (int)
+        4.18. alias_name (string)
 
    5. Functions
 
@@ -247,10 +250,11 @@ Chapter 1. Admin Guide
    4.11. nortpproxy_str (string)
    4.12. keepalive_timeout (int)
    4.13. udpping_from_path (int)
-   4.14. append_sdp_oldmediaip (int)
-   4.15. filter_server_id (int)
-   4.16. nat_addr_mode (int)
-   4.17. alias_name (string)
+   4.14. ignore_path (int)
+   4.15. append_sdp_oldmediaip (int)
+   4.16. filter_server_id (int)
+   4.17. nat_addr_mode (int)
+   4.18. alias_name (string)
 
 4.1. force_socket (string)
 
@@ -449,31 +453,44 @@ modparam("nathelper", "keepalive_timeout", 120)
 modparam("nathelper", "udpping_from_path", 1)
 ...
 
-4.14. append_sdp_oldmediaip (int)
+4.14. ignore_path (int)
+
+   Enable ignore of Path header address when sending UDP pings
+   (keepalives).
+
+   Default value is “0” (feature disabled). UDP pings are sent to Path
+   header if header is present.
+
+   Example 1.14. Set ignore_path parameter
+...
+modparam("nathelper", "ignore_path", 1)
+...
+
+4.15. append_sdp_oldmediaip (int)
 
    The parameter controls if oldmediaip field should be appended to the
    SDP.
 
    Default value is “1” (feature enabled).
 
-   Example 1.14. Set append_sdp_oldmediaip parameter
+   Example 1.15. Set append_sdp_oldmediaip parameter
 ...
 modparam("nathelper", "append_sdp_oldmediaip", 1)
 ...
 
-4.15. filter_server_id (int)
+4.16. filter_server_id (int)
 
    Filter contacts by “server_id” core parameter. Use this parameter to
    limit pinging. When set to “1”, only proxy instances which send packets
    are those where core server_id matches server_id saved in usrloc.
    Default value is “0” (disabled).
 
-   Example 1.15. Set filter_server_id parameter
+   Example 1.16. Set filter_server_id parameter
 ...
 modparam("nathelper", "filter_server_id", 1)
 ...
 
-4.16. nat_addr_mode (int)
+4.17. nat_addr_mode (int)
 
    If set to 0, only default private net addresses are checked by
    nat_uac_test(). If set to 1, other reserved net addresses are checked
@@ -491,12 +508,12 @@ modparam("nathelper", "filter_server_id", 1)
 
    Default value is “1”.
 
-   Example 1.16. Set nat_addr_mode parameter
+   Example 1.17. Set nat_addr_mode parameter
 ...
 modparam("nathelper", "nat_addr_mode", 0)
 ...
 
-4.17. alias_name (string)
+4.18. alias_name (string)
 
    The parameter sets the name of the Contact URI parameter set by
    set_contact_alias() or add_contact_alias() and processed by
@@ -504,7 +521,7 @@ modparam("nathelper", "nat_addr_mode", 0)
 
    Default value is “alias”.
 
-   Example 1.17. Set alias_name parameter
+   Example 1.18. Set alias_name parameter
 ...
 modparam("nathelper", "alias_name", "saddr")
 ...
@@ -530,7 +547,7 @@ modparam("nathelper", "alias_name", "saddr")
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
    BRANCH_ROUTE.
 
-   Example 1.18. fix_nated_contact usage
+   Example 1.19. fix_nated_contact usage
 ...
 if (search("User-Agent: Cisco ATA.*") {fix_nated_contact();};
 ...
@@ -563,7 +580,7 @@ if (search("User-Agent: Cisco ATA.*") {fix_nated_contact();};
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
    FAILURE_ROUTE, BRANCH_ROUTE.
 
-   Example 1.19. fix_nated_sdp usage
+   Example 1.20. fix_nated_sdp usage
 ...
 if (search("User-Agent: Cisco ATA.*") {fix_nated_sdp("3");};
 ...
@@ -587,7 +604,7 @@ if (search("User-Agent: Cisco ATA.*") {fix_nated_sdp("3");};
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1.20. add_rcv_param usage
+   Example 1.21. add_rcv_param usage
 ...
 add_rcv_param(); # add the parameter to the Contact header
 ....
@@ -607,7 +624,7 @@ add_rcv_param("1"); # add the parameter to the Contact URI
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1.21. fix_nated_register usage
+   Example 1.22. fix_nated_register usage
 ...
 fix_nated_register();
 ...
@@ -650,7 +667,7 @@ fix_nated_register();
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
    FAILURE_ROUTE, BRANCH_ROUTE.
 
-   Example 1.22. nat_uac_test usage
+   Example 1.23. nat_uac_test usage
 ...
 if(nat_uac_test("19")) {
     rtpproxy_manage("co");
@@ -664,7 +681,7 @@ if(nat_uac_test("19")) {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.23. is_rfc1918 usage
+   Example 1.24. is_rfc1918 usage
 ...
 if(is_rfc1918("$rd")) {
     # domain in r-uri is private address
@@ -682,7 +699,7 @@ if(is_rfc1918("$rd")) {
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
    BRANCH_ROUTE, and LOCAL_ROUTE.
 
-   Example 1.24. add_contact_alias usage
+   Example 1.25. add_contact_alias usage
 ...
     if (!is_present_hf("Record-Route")) {
         if (!add_contact_alias("$var(src_ip)", "$Rp", "tcp")) {
@@ -713,7 +730,7 @@ if(is_rfc1918("$rd")) {
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, and
    LOCAL_ROUTE.
 
-   Example 1.25. handle_ruri_alias usage
+   Example 1.26. handle_ruri_alias usage
 ...
     if ($du == "") {
         handle_ruri_alias();
@@ -750,7 +767,7 @@ if(is_rfc1918("$rd")) {
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
    BRANCH_ROUTE, and FAILURE_ROUTE.
 
-   Example 1.26. set_contact_alias usage
+   Example 1.27. set_contact_alias usage
 ...
     if (!is_present_hf("Record-Route")) {
         if (!set_contact_alias()) {
@@ -769,7 +786,7 @@ if(is_rfc1918("$rd")) {
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
    BRANCH_ROUTE, and FAILURE_ROUTE.
 
-   Example 1.27. set_alias_to_pv usage
+   Example 1.28. set_alias_to_pv usage
 ...
                 set_alias_to_pv("$avp(aliasuri)");
 ...
@@ -783,7 +800,7 @@ if(is_rfc1918("$rd")) {
 
    Number of Record Routes in received SIP request or reply.
 
-   Example 1.28. $rr_count usage
+   Example 1.29. $rr_count usage
 ...
     $avp(rr_count) = $rr_count;
 ...
@@ -795,7 +812,7 @@ if(is_rfc1918("$rd")) {
    value of $rr_top_count is 1. If there is no Record Route(s), value of
    $rr_top_count is 0.
 
-   Example 1.29. $rr_top_count usage
+   Example 1.30. $rr_top_count usage
 ...
     if ($rr_count == $avp(rr_count) + $rr_top_count) {
         route(ADD_CONTACT_ALIAS);
@@ -813,7 +830,7 @@ if(is_rfc1918("$rd")) {
 
    The function takes only one parameter - a number in decimal format.
 
-   Example 1.30. nathelper.enable_ping usage
+   Example 1.31. nathelper.enable_ping usage
 ...
 $ kamcmd nathelper.enable_ping 1
 ...
@@ -828,7 +845,7 @@ $ kamcmd nathelper.enable_ping 1
    counted from 1. Only IP:port is rewritten, remaining parts are left
    unchanged. Full nameaddr is supported.
 
-   Example 1.31. @nathelper.rewrite_contact usage
+   Example 1.32. @nathelper.rewrite_contact usage
 ...
 $c = @nathelper.rewrite_contact[1];
 ...