[sr-dev] git:master:87787c2e: rr: documentation for force_send_socket parameter

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 87787c2eccdb6c0ebfd8931a5acbebb25a40bbe8
URL: https://github.com/kamailio/kamailio/commit/87787c2eccdb6c0ebfd8931a5acbebb25a40bbe8

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2018-02-07T13:22:51+01:00

rr: documentation for force_send_socket parameter

---

Modified: src/modules/rr/doc/rr_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/87787c2eccdb6c0ebfd8931a5acbebb25a40bbe8.diff
Patch: https://github.com/kamailio/kamailio/commit/87787c2eccdb6c0ebfd8931a5acbebb25a40bbe8.patch

---

diff --git a/src/modules/rr/doc/rr_admin.xml b/src/modules/rr/doc/rr_admin.xml
index b64930a665..d8b9ce7adb 100644
--- a/src/modules/rr/doc/rr_admin.xml
+++ b/src/modules/rr/doc/rr_admin.xml
@@ -265,6 +265,31 @@ modparam("rr", "custom_user_avp", "$avp(RR_CUSTOMER_USER_AVP)")
 $avp(RR_CUSTOM_USER_AVP)="mo";
 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>