[sr-dev] git:5.0:1e5eb8bb: modules/sipcapture: improve nonsip_hook documentation

[Øyvind Kolbu]

Module: kamailio
Branch: 5.0
Commit: 1e5eb8bb8ae5fe4f2a8e8940462bdd67ea760d43
URL: https://github.com/kamailio/kamailio/commit/1e5eb8bb8ae5fe4f2a8e8940462bdd67ea760d43

Author: Mikko Lehto <mslehto at iki.fi>
Committer: Øyvind Kolbu <oyvind.kolbu at usit.uio.no>
Date: 2017-10-25T10:50:22+02:00

modules/sipcapture: improve nonsip_hook documentation

(cherry picked from commit 2f872dcc684a345cff09a437ae4a3767613b5529)

---

Modified: src/modules/sipcapture/doc/sipcapture_admin.xml
Modified: src/modules/sipcapture/examples/kamailio.cfg

---

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

---

diff --git a/src/modules/sipcapture/doc/sipcapture_admin.xml b/src/modules/sipcapture/doc/sipcapture_admin.xml
index 8916317cb0..d9d47cceda 100644
--- a/src/modules/sipcapture/doc/sipcapture_admin.xml
+++ b/src/modules/sipcapture/doc/sipcapture_admin.xml
@@ -493,6 +493,26 @@ modparam("sipcapture", "topoh_unmask", 1)
 			</programlisting>
 		</example>
 	</section>
+
+	<section id="sipcapture.p.nonsip_hook">
+		<title><varname>nonsip_hook</varname> (int)</title>
+		<para>
+		If set to 1, event route <emphasis>sipcapture:siprequest</emphasis> is
+		run when HEP message is received.
+		</para>
+		<para>
+			Default value is <emphasis>0</emphasis>.
+		</para>
+		<example>
+			<title>Set <varname>nonsip_hook</varname> parameter</title>
+			<programlisting format="linespecific">
+...
+modparam("sipcapture", "nonsip_hook", 1)
+...
+			</programlisting>
+		</example>
+	</section>
+
 </section>	
 <section>
 	<title>Functions</title>
diff --git a/src/modules/sipcapture/examples/kamailio.cfg b/src/modules/sipcapture/examples/kamailio.cfg
index 3d42a78f47..14a5641a1c 100644
--- a/src/modules/sipcapture/examples/kamailio.cfg
+++ b/src/modules/sipcapture/examples/kamailio.cfg
@@ -861,10 +861,6 @@ route[STORE] {
 	sip_capture("$var(a)");
 }
 
-event_route[sipcapture:request] {
-	xlog("received sipcapture request from $si:$sp\r\n");
-}
-
 #!ifdef WITH_HOMER_CUSTOM_STATS
 event_route[xhttp:request] {
         set_reply_close();
@@ -908,12 +904,14 @@ event_route[xhttp:request] {
 
 event_route[sipcapture:request] {
 
-        xlog("HEP Request!\n");
-        xlog("received sipcapture request from $si:$sp\r\n");
-        xlog("HEP VERSION $hep(version) request from $si:$sp\r\n");
-        xlog("HEP CHUNK Source IP $hep(0x002) request from $si:$sp\r\n");
+	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){
+	if($hep(0x00b) == 1)
+	{
 
 		#Do parsing internal
 		return 1;
@@ -921,8 +919,8 @@ event_route[sipcapture:request] {
 	else 
 	{
 		#If report lets proceed here with payload
-	        xlog("HEP CHUNK PAYLOAD $hep(0x00f) request from $si:$sp\r\n");
-        	return 0;   
+		xlog("HEP CHUNK PAYLOAD $hep(0x00f) request from $si:$sp\n");
+		return 0;
 	}
 }