[sr-dev] git:master:872ef07a: sipcapture: documentation for event_callback parameter

[Daniel-Constantin Mierla]

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

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

sipcapture: documentation for event_callback parameter

---

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

---

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

---

diff --git a/src/modules/sipcapture/doc/sipcapture_admin.xml b/src/modules/sipcapture/doc/sipcapture_admin.xml
index ef89683153..57b84f96bb 100644
--- a/src/modules/sipcapture/doc/sipcapture_admin.xml
+++ b/src/modules/sipcapture/doc/sipcapture_admin.xml
@@ -513,7 +513,40 @@ modparam("sipcapture", "nonsip_hook", 1)
 		</example>
 	</section>
 
-</section>	
+	<section id="sipcapture.p.event_callback">
+		<title><varname>event_callback</varname> (str)</title>
+		<para>
+			The name of the function in the kemi configuration file (embedded
+			scripting language such as Lua, Python, ...) to be executed instead
+			of event_route[...] blocks.
+		</para>
+		<para>
+			The function receives a string parameter with the name of the event,
+			the values can be: 'sipcapture:request'.
+		</para>
+		<para>
+		<emphasis>
+			Default value is 'empty' (no function is executed for events).
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>event_callback</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("sipcapture", "event_callback", "ksr_sipcapture_event")
+...
+-- event callback function implemented in Lua
+function ksr_sipcapture_event(evname)
+	KSR.info("===== sipcapture module triggered event: " .. evname .. "\n");
+	return 1;
+end
+...
+</programlisting>
+		</example>
+	</section>
+
+</section>
+
 <section>
 	<title>Functions</title>
 	<section id="sipcapture.f.sip_capture">