rr: documentation for force_send_socket parameter
authorDaniel-Constantin Mierla <miconda@gmail.com>
Wed, 7 Feb 2018 12:22:25 +0000 (13:22 +0100)
committerDaniel-Constantin Mierla <miconda@gmail.com>
Wed, 7 Feb 2018 12:22:51 +0000 (13:22 +0100)
src/modules/rr/doc/rr_admin.xml

index b64930a..d8b9ce7 100644 (file)
@@ -268,6 +268,31 @@ record_route();
 </programlisting>
       </example>
     </section>
+    <section id="rr.p.force_send_socket">
+      <title><varname>force_send_socket</varname> (int)</title>
+
+         <para>
+                 If set to 1, local socket is forced even for single Record-Route,
+                 otherwise is done on double Record-Route (should that be enabled).
+         </para>
+
+         <para>
+                 When use of <quote>outbound</quote> is enabled, the socket is not
+                 forced.
+         </para>
+
+      <para><emphasis>Default value is 0.</emphasis></para>
+
+      <example>
+        <title>Set <varname>force_send_socket</varname> parameter</title>
+
+        <programlisting format="linespecific">
+...
+modparam("rr", "force_send_socket", 1)
+...
+</programlisting>
+      </example>
+    </section>
   </section>
 
   <section>