Module: kamailio
Branch: master
Commit: aab836d84d1121f9c8dd3b0fb090d6767b4e05a8
URL: https://github.com/kamailio/kamailio/commit/aab836d84d1121f9c8dd3b0fb090d67…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)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/aab836d84d1121f9c8dd3b0fb090d67…
Patch: https://github.com/kamailio/kamailio/commit/aab836d84d1121f9c8dd3b0fb090d67…
---
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>
<!-- Kamailio Pull Request Template -->
<!--
IMPORTANT:
- for detailed contributing guidelines, read:
https://github.com/kamailio/kamailio/blob/master/.github/CONTRIBUTING.md
- pull requests must be done to master branch, unless they are backports
of fixes from master branch to a stable branch
- backports to stable branches must be done with 'git cherry-pick -x ...'
- code is contributed under BSD for core and main components (tm, sl, auth, tls)
- code is contributed GPLv2 or a compatible license for the other components
- GPL code is contributed with OpenSSL licensing exception
-->
#### Pre-Submission Checklist
<!-- Go over all points below, and after creating the PR, tick all the checkboxes that apply -->
<!-- All points should be verified, otherwise, read the CONTRIBUTING guidelines from above-->
<!-- If you're unsure about any of these, don't hesitate to ask on sr-dev mailing list -->
- [ ] Commit message has the format required by CONTRIBUTING guide
- [ ] Commits are split per component (core, individual modules, libs, utils, ...)
- [ ] Each component has a single commit (if not, squash them into one commit)
- [ ] No commits to README files for modules (changes must be done to docbook files
in `doc/` subfolder, the README file is autogenerated)
#### Type Of Change
- [ ] Small bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds new functionality)
- [ ] Breaking change (fix or feature that would change existing functionality)
#### Checklist:
<!-- Go over all points below, and after creating the PR, tick the checkboxes that apply -->
- [ ] PR should be backported to stable branches
- [ ] Tested changes locally
- [ ] Related to issue #XXXX (replace XXXX with an open issue number)
#### Description
<!-- Describe your changes in detail -->
You can view, comment on, or merge this pull request online at:
https://github.com/kamailio/kamailio/pull/1873
-- Commit Summary --
* tls: Minor spelling fix in workaround message
* utils: Fix copy/paste of 'database port'
-- File Changes --
M src/modules/tls/tls_init.c (2)
M utils/kamctl/kamctlrc (2)
-- Patch Links --
https://github.com/kamailio/kamailio/pull/1873.patchhttps://github.com/kamailio/kamailio/pull/1873.diff
--
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/pull/1873