[sr-dev] git:master:d867d8ab: sipcapture: docs for sip_capture_forward(uri)

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2018-05-02T12:18:57+02:00

sipcapture: docs for sip_capture_forward(uri)

---

Modified: src/modules/sipcapture/doc/sipcapture_admin.xml

---

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

---

diff --git a/src/modules/sipcapture/doc/sipcapture_admin.xml b/src/modules/sipcapture/doc/sipcapture_admin.xml
index 5f7055a4b6..0dbfafae96 100644
--- a/src/modules/sipcapture/doc/sipcapture_admin.xml
+++ b/src/modules/sipcapture/doc/sipcapture_admin.xml
@@ -648,6 +648,36 @@ report_capture("report_data", "$ci", "{\"MOS\":4.1,\"PACKET_LOST\":100"});
 ...
 $var(res) = float2int("10.5", "1");
 ...
+</programlisting>
+		</example>
+	</section>
+	<section id="sipcapture.f.sip_capture_forward">
+		<title>
+		<function moreinfo="none">sip_capture_forward(uri)</function>
+		</title>
+		<para>
+		Forward the HEP packet to an address specified by the parameter uri
+		(it has to be a sip uri format). The function should be used inside
+		event_route[sipcapture:request]. After using this function, add a
+		return 0 in order to stop processing further the packet in the local
+		&kamailio; instance.
+		</para>
+		<para>
+		This function can be used from ANY_ROUTE.
+		</para>
+		<example>
+		<title><function>sip_capture_forward()</function> usage</title>
+		<programlisting format="linespecific">
+...
+    event_route[sipcapture:request] {
+        ...
+        if(src_ip==1.2.3.4) {
+            sip_capture_forward("sip:2.3.4.5:5090");
+            return 0;
+        }
+        ...
+    }
+...
 </programlisting>
 		</example>
 	</section>