[sr-dev] git:master:8400eb35: sipcapture: documentation for event routes

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2017-11-05T10:23:23+01:00

sipcapture: documentation for event routes

---

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

---

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

---

diff --git a/src/modules/sipcapture/doc/sipcapture_admin.xml b/src/modules/sipcapture/doc/sipcapture_admin.xml
index 55ba34b4ec..ef89683153 100644
--- a/src/modules/sipcapture/doc/sipcapture_admin.xml
+++ b/src/modules/sipcapture/doc/sipcapture_admin.xml
@@ -621,6 +621,46 @@ $var(res) = float2int("10.5", "1");
 	</section>
 
     <section>
+	<title>Event Routes</title>
+	<section id="sipcapture.ev.request">
+		<title>event_route[sipcapture:request]</title>
+		<para>
+			Event route block to be executed when HEP packet is received. It
+			requires module parameter 'nonsip_hook' to be set to 1.
+		</para>
+		<example>
+		<title>event_route[sipcapture:request] usage</title>
+		<programlisting format="linespecific">
+...
+# new event sipcapture socket
+modparam("sipcapture", "nonsip_hook", 1)
+...
+
+event_route[sipcapture:request] {
+
+	xlog("HEP Request!\n");
+	xlog("received sipcapture request from $si:$sp\n");
+	xlog("HEP VERSION $hep(version) request from $si:$sp\n");
+	xlog("HEP CHUNK Source IP $hep(0x002) request from $si:$sp\n");
+
+	# is it SIP ?
+	if($hep(0x00b) == 1) {
+
+		# do parsing internal
+		return 1;
+	} else {
+		# if report lets proceed here with payload
+		xlog("HEP CHUNK PAYLOAD $hep(0x00f) request from $si:$sp\n");
+		return 0;
+	}
+}
+...
+</programlisting>
+		</example>
+	</section>
+	</section>
+
+    <section>
 	<title>RPC Commands</title>
 	<section id="sipcapture.r.sipcapture.status">
 		<title>