From 981701d4ffa8bce2be3768f43cbde0f5344390fc Mon Sep 17 00:00:00 2001 From: Kamailio Dev Date: Mon, 29 Mar 2021 15:31:11 +0200 Subject: [PATCH] modules: readme files regenerated - path ... [skip ci] --- src/modules/path/README | 63 +++++++++++++++++++++++++---------------- 1 file changed, 39 insertions(+), 24 deletions(-) diff --git a/src/modules/path/README b/src/modules/path/README index a97313923af..2def14a628f 100644 --- a/src/modules/path/README +++ b/src/modules/path/README @@ -31,8 +31,9 @@ Richard Fuchs 3.1. use_received (int) 3.2. received_format (int) - 3.3. enable_r2 (int) - 3.4. sockname_mode (int) + 3.3. received_name (str) + 3.4. enable_r2 (int) + 3.5. sockname_mode (int) 4. Functions @@ -48,14 +49,15 @@ Richard Fuchs 1.1. Add Supported header 1.2. Set use_received parameter 1.3. Set received_format parameter - 1.4. Set enable_r2 parameter - 1.5. Set sockname_mode parameter - 1.6. add_path usage - 1.7. add_path(user) usage - 1.8. add_path(user, parameters) usage - 1.9. add_path_received() usage - 1.10. add_path_received(user) usage - 1.11. add_path_received(user, parameters) usage + 1.4. Set received_name parameter + 1.5. Set enable_r2 parameter + 1.6. Set sockname_mode parameter + 1.7. add_path usage + 1.8. add_path(user) usage + 1.9. add_path(user, parameters) usage + 1.10. add_path_received() usage + 1.11. add_path_received(user) usage + 1.12. add_path_received(user, parameters) usage Chapter 1. Admin Guide @@ -75,8 +77,9 @@ Chapter 1. Admin Guide 3.1. use_received (int) 3.2. received_format (int) - 3.3. enable_r2 (int) - 3.4. sockname_mode (int) + 3.3. received_name (str) + 3.4. enable_r2 (int) + 3.5. sockname_mode (int) 4. Functions @@ -162,8 +165,9 @@ append_hf("Supported: path\r\n"); 3.1. use_received (int) 3.2. received_format (int) - 3.3. enable_r2 (int) - 3.4. sockname_mode (int) + 3.3. received_name (str) + 3.4. enable_r2 (int) + 3.5. sockname_mode (int) 3.1. use_received (int) @@ -195,7 +199,18 @@ modparam("path", "use_received", 1) modparam("path", "received_format", 1) ... -3.3. enable_r2 (int) +3.3. received_name (str) + + Set the name of the header parameter to add the “received” value. + + Default value is "received". + + Example 1.4. Set received_name parameter +... +modparam("path", "received_name", "rcv") +... + +3.4. enable_r2 (int) If set to 1, the module will add two Path headers, similar to the double Record-Route done by rr module. One Path headers corresponds to @@ -210,19 +225,19 @@ modparam("path", "received_format", 1) Default value is 0. - Example 1.4. Set enable_r2 parameter + Example 1.5. Set enable_r2 parameter ... modparam("path", "enable_r2", 1) ... -3.4. sockname_mode (int) +3.5. sockname_mode (int) If set to 1, the Path URI is built to contain socket name in 'sn' parameter. Default value is 0. - Example 1.5. Set sockname_mode parameter + Example 1.6. Set sockname_mode parameter ... modparam("path", "sockname_mode", 1) ... @@ -251,7 +266,7 @@ modparam("path", "sockname_mode", 1) This function can be used from REQUEST_ROUTE. - Example 1.6. add_path usage + Example 1.7. add_path usage ... if (!add_path()) { sl_send_reply("503", "Internal Path Error"); @@ -269,7 +284,7 @@ if (!add_path()) { This function can be used from REQUEST_ROUTE. - Example 1.7. add_path(user) usage + Example 1.8. add_path(user) usage ... if (!add_path("loadbalancer")) { sl_send_reply("503", "Internal Path Error"); @@ -291,7 +306,7 @@ if (!add_path("loadbalancer")) { This function can be used from REQUEST_ROUTE. - Example 1.8. add_path(user, parameters) usage + Example 1.9. add_path(user, parameters) usage ... if (!add_path("loadbalancer", "ob")) { sl_send_reply("503", "Internal Path Error"); @@ -315,7 +330,7 @@ if (!add_path("loadbalancer", "ob")) { This function can be used from REQUEST_ROUTE. - Example 1.9. add_path_received() usage + Example 1.10. add_path_received() usage ... if (!add_path_received()) { sl_send_reply("503", "Internal Path Error"); @@ -332,7 +347,7 @@ if (!add_path_received()) { This function can be used from REQUEST_ROUTE. - Example 1.10. add_path_received(user) usage + Example 1.11. add_path_received(user) usage ... if (!add_path_received("inbound")) { sl_send_reply("503", "Internal Path Error"); @@ -349,7 +364,7 @@ if (!add_path_received("inbound")) { This function can be used from REQUEST_ROUTE. - Example 1.11. add_path_received(user, parameters) usage + Example 1.12. add_path_received(user, parameters) usage ... if (!add_path_received("inbound", "ob")) { sl_send_reply("503", "Internal Path Error");