From 8f242cfb151bbe4fdf4101f4bde59083307e6f8a Mon Sep 17 00:00:00 2001 From: Daniel-Constantin Mierla Date: Tue, 27 Jun 2017 15:52:54 +0200 Subject: [PATCH] path: documentation for enable_r2 and received_format parameters --- src/modules/path/doc/path_admin.xml | 57 +++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) diff --git a/src/modules/path/doc/path_admin.xml b/src/modules/path/doc/path_admin.xml index 31b8a572d90..4712a097165 100644 --- a/src/modules/path/doc/path_admin.xml +++ b/src/modules/path/doc/path_admin.xml @@ -140,6 +140,63 @@ append_hf("Supported: path\r\n"); ... modparam("path", "use_received", 1) ... + + + +
+ <varname>received_format</varname> (int) + + If set to 0, the received parameter value will be + in the escaped SIP URI format. + + + If set to 1, the received parameter value will be + in the same format as the alias parameter added by + set_contact_alias() from nathelper module (i.e., + ip~port~protid). This is a solution with some + SIP applications that incorrectly match the transport from + received parameter instead of the one from the SIP URI. + + + + Default value is 0. + + + + Set <varname>received_format</varname> parameter + +... +modparam("path", "received_format", 1) +... + + +
+
+ <varname>enable_r2</varname> (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 incoming network socket and the other to outgoing network socket. + The URIs in the Path headers will have the 'r2=on' parameter as well. + + + Note: if enabled, the module adds the two Path headers even when the + incoming socket is the same as outgoing socket. Improvements to skip + the second Path header in this case may be introduced in the future, + meanwhile, if you need to enable this parameter but also deal with + same socket routing, use 'insert_hf("Path: <$Ru>\r\n")'. + + + + Default value is 0. + + + + Set <varname>use_received</varname> parameter + +... +modparam("path", "use_received", 1) +...