[sr-dev] git:master:9ddef157: rr: docs for rr_next_hop_route() function

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 9ddef1571c5508f2b12614d3cebac4368609a498
URL: https://github.com/kamailio/kamailio/commit/9ddef1571c5508f2b12614d3cebac4368609a498

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2019-12-13T16:14:04+01:00

rr: docs for rr_next_hop_route() function

---

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

---

Diff:  https://github.com/kamailio/kamailio/commit/9ddef1571c5508f2b12614d3cebac4368609a498.diff
Patch: https://github.com/kamailio/kamailio/commit/9ddef1571c5508f2b12614d3cebac4368609a498.patch

---

diff --git a/src/modules/rr/doc/rr_admin.xml b/src/modules/rr/doc/rr_admin.xml
index 362edd4f1f..01bee1b451 100644
--- a/src/modules/rr/doc/rr_admin.xml
+++ b/src/modules/rr/doc/rr_admin.xml
@@ -649,6 +649,35 @@ if (is_direction("downstream")) {
 </programlisting>
       </example>
     </section>
+
+    <section id="rr.f.rr_next_hop_route">
+		<title><function moreinfo="none">rr_next_hop_route()</function></title>
+
+		<para>The function returns 1 (true) if there is a Route header for the
+			next hop address. It has to be used after loose_route(), when the
+			local Route headers are processed.
+		</para>
+
+		<para>
+			This function can be used from ANY_ROUTE.
+		</para>
+
+      <example>
+        <title><function>rr_next_hop_route</function> usage</title>
+
+        <programlisting format="linespecific">
+...
+if(loose_route) {
+    if(rr_next_hop_route()) {
+        # next hop address is from Route header
+    }
+
+}
+...
+</programlisting>
+      </example>
+  </section>
+
   </section>
 
   <section>