[sr-dev] git:master:27062612: evapi: documentation for event_callaback

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2017-04-04T22:21:16+02:00

evapi: documentation for event_callaback

---

Modified: src/modules/evapi/doc/evapi_admin.xml

---

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

---

diff --git a/src/modules/evapi/doc/evapi_admin.xml b/src/modules/evapi/doc/evapi_admin.xml
index 3cb587e..41bb01b 100644
--- a/src/modules/evapi/doc/evapi_admin.xml
+++ b/src/modules/evapi/doc/evapi_admin.xml
@@ -122,6 +122,38 @@ modparam("evapi", "netstring_format", 0)
 </programlisting>
 		</example>
 	</section>
+	<section id="evapi.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 are: 'evapi:connection-new', 'evapi:connection-closed',
+			'evapi:message-received'.
+		</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("evapi", "event_callback", "ksr_evapi_event")
+...
+-- event callback function implemented in Lua
+function ksr_evapi_event(evname)
+	KSR.info("===== evapi module triggered event: " .. evname .. "\n");
+	return 1;
+end
+...
+</programlisting>
+		</example>
+	</section>
 	</section>
 
 	<section>