[sr-dev] git:master:8f242cfb: path: documentation for enable_r2 and received_format parameters

Module: kamailio Branch: master Commit: 8f242cfb151bbe4fdf4101f4bde59083307e6f8a URL: https://github.com/kamailio/kamailio/commit/8f242cfb151bbe4fdf4101f4bde5908… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2017-06-27T15:52:54+02:00 path: documentation for enable_r2 and received_format parameters --- Modified: src/modules/path/doc/path_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/8f242cfb151bbe4fdf4101f4bde5908… Patch: https://github.com/kamailio/kamailio/commit/8f242cfb151bbe4fdf4101f4bde5908… --- diff --git a/src/modules/path/doc/path_admin.xml b/src/modules/path/doc/path_admin.xml index 31b8a572d9..4712a09716 100644 --- a/src/modules/path/doc/path_admin.xml +++ b/src/modules/path/doc/path_admin.xml @@ -143,6 +143,63 @@ modparam("path", "use_received", 1) </programlisting> </example> </section> + <section id="path.p.received_format"> + <title><varname>received_format</varname> (int)</title> + <para> + If set to 0, the <quote>received</quote> parameter value will be + in the escaped SIP URI format. + </para> + <para> + If set to 1, the <quote>received</quote> parameter value will be + in the same format as the <quote>alias</quote> parameter added by + set_contact_alias() from <quote>nathelper</quote> module (i.e., + <quote>ip~port~protid</quote>). This is a solution with some + SIP applications that incorrectly match the transport from + received parameter instead of the one from the SIP URI. + </para> + <para> + <emphasis> + Default value is 0. + </emphasis> + </para> + <example> + <title>Set <varname>received_format</varname> parameter</title> + <programlisting format="linespecific"> +... +modparam("path", "received_format", 1) +... +</programlisting> + </example> + </section> + <section id="path.p.enable_r2"> + <title><varname>enable_r2</varname> (int)</title> + <para> + 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. + </para> + <para> + 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: &lt;$Ru&gt;\r\n")'. + </para> + <para> + <emphasis> + Default value is 0. + </emphasis> + </para> + <example> + <title>Set <varname>use_received</varname> parameter</title> + <programlisting format="linespecific"> +... +modparam("path", "use_received", 1) +... +</programlisting> + </example> + </section> </section> <section>