[sr-dev] git:master:e78d2ffb: tm: docs for event_callback_lres_sent param

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2019-08-27T13:22:24+02:00

tm: docs for event_callback_lres_sent param

---

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

---

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

---

diff --git a/src/modules/tm/doc/params.xml b/src/modules/tm/doc/params.xml
index e17137c0cd..4c583ca782 100644
--- a/src/modules/tm/doc/params.xml
+++ b/src/modules/tm/doc/params.xml
@@ -1431,7 +1431,37 @@ modparam("tm", "event_callback", "ksr_tm_event")
 ...
 -- event callback function implemented in Lua
 function ksr_tm_event(evname)
-	KSR.info("===== htable module triggered event: " .. evname .. "\n");
+	KSR.info("===== tm module triggered event: " .. evname .. "\n");
+	return 1;
+end
+...
+</programlisting>
+		</example>
+	</section>
+
+	<section id="tm.p.event_callback_lres_sent">
+		<title><varname>event_callback_lres</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[tm:local-response] block. The function receives
+			a string parameter with the name of the event, respectively
+			"tm:local-response".
+		</para>
+		<para>
+		<emphasis>
+			Default value is 'empty' (no function is executed for events).
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>event_callback_lres_sent</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("tm", "event_callback_lres_sent", "ksr_tm_event_response_sent")
+...
+-- event callback function implemented in Lua
+function ksr_tm_event_response_sent(evname)
+	KSR.info("===== tm module triggered event: " .. evname .. "\n");
 	return 1;
 end
 ...