[sr-dev] git:master:aab836d8: tcpops: docs for event_callback parameter

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2019-02-28T08:43:13+01:00

tcpops: docs for event_callback parameter

---

Modified: src/modules/tcpops/doc/params.xml

---

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

---

diff --git a/src/modules/tcpops/doc/params.xml b/src/modules/tcpops/doc/params.xml
index 5d04783eb1..1f7aaa507f 100644
--- a/src/modules/tcpops/doc/params.xml
+++ b/src/modules/tcpops/doc/params.xml
@@ -13,7 +13,7 @@
     </sectioninfo>
 
     <title>Parameters</title>
-		<section>
+	<section>
 		<title><varname>closed_event</varname> (int)</title>
 		<para>
 			If set to 0 (globally disabled), the "tcp:closed" event route will never be called on TCP
@@ -42,7 +42,36 @@ modparam("tcpops", "closed_event", 0)
 </programlisting>
 		</example>
 	</section>
-
-
+	<section id="tcpops.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: 'tcp:closed', 'tcp:timeout', 'tcp:reset'.
+		</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("tcpops", "event_callback", "ksr_tcpops_event")
+...
+-- event callback function implemented in Lua
+function ksr_tcpops_event(evname)
+	KSR.info("===== evapi module triggered event: " .. evname .. "\n");
+	return 1;
+end
+...
+</programlisting>
+		</example>
+	</section>
 
 </section>