[sr-dev] git:master:3a6a55ac: sipdump: docs for mode and event_callback parameters

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2020-01-22T13:17:34+01:00

sipdump: docs for mode and event_callback parameters

---

Modified: src/modules/sipdump/doc/sipdump_admin.xml

---

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

---

diff --git a/src/modules/sipdump/doc/sipdump_admin.xml b/src/modules/sipdump/doc/sipdump_admin.xml
index 6581238de1..3369069b26 100644
--- a/src/modules/sipdump/doc/sipdump_admin.xml
+++ b/src/modules/sipdump/doc/sipdump_admin.xml
@@ -76,7 +76,7 @@
 	<section id="sipdump.p.enable">
 		<title><varname>enable</varname> (int)</title>
 		<para>
-			Enable storage.
+			Enable sipdump activity.
 		</para>
 		<para>
 		<emphasis>
@@ -89,6 +89,26 @@
 ...
 modparam("sipdump", "enable", 1)
 ...
+</programlisting>
+		</example>
+	</section>
+	<section id="sipdump.p.mode">
+		<title><varname>mode</varname> (int)</title>
+		<para>
+			Set the type of activity done by the module, the value can be set
+			based on flags: 1 - write to files; 2 - execute event route
+		</para>
+		<para>
+		<emphasis>
+			Default value is 1 (write to files).
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>mode</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("sipdump", "mode", 3)
+...
 </programlisting>
 		</example>
 	</section>
@@ -166,6 +186,31 @@ modparam("sipdump", "folder", "/run/kamailio")
 ...
 modparam("sipdump", "fprefix", "ksipdump-")
 ...
+</programlisting>
+		</example>
+	</section>
+	<section id="sipdump.p.event_callback">
+		<title><varname>event_callback</varname> (str)</title>
+		<para>
+			Name of the KEMI function to be executed instead of the event route.
+		</para>
+		<para>
+		<emphasis>
+			Default value is not set.
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>event_callback</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("sipdump", "event_callback", "ksr_sipdump_event")
+...
+-- event callback function implemented in Lua
+function ksr_sipdump_event(evname)
+	KSR.info("===== sipdump module triggered event: " .. evname .. "\n");
+	return 1;
+end
+...
 </programlisting>
 		</example>
 	</section>