[sr-dev] git:master:5f0792e7: modules: readme files regenerated - topos ... [skip ci]

Module: kamailio Branch: master Commit: 5f0792e7ee985b80601e6f952269bc48031e6356 URL: https://github.com/kamailio/kamailio/commit/5f0792e7ee985b80601e6f952269bc4… Author: Kamailio Dev <kamailio.dev(a)kamailio.org> Committer: Kamailio Dev <kamailio.dev(a)kamailio.org> Date: 2017-08-07T11:31:22+02:00 modules: readme files regenerated - topos ... [skip ci] --- Modified: src/modules/topos/README --- Diff: https://github.com/kamailio/kamailio/commit/5f0792e7ee985b80601e6f952269bc4… Patch: https://github.com/kamailio/kamailio/commit/5f0792e7ee985b80601e6f952269bc4… --- diff --git a/src/modules/topos/README b/src/modules/topos/README index 3e42389014..cf4bce61f6 100644 --- a/src/modules/topos/README +++ b/src/modules/topos/README @@ -32,6 +32,11 @@ Daniel-Constantin Mierla 3.5. branch_expire (int) 3.6. dialog_expire (int) 3.7. clean_interval (int) + 3.8. event_callback (str) + + 4. Event Routes + + 4.1. event_route[topos:msg-outgoing] List of Examples @@ -42,6 +47,8 @@ Daniel-Constantin Mierla 1.5. Set branch_expire parameter 1.6. Set dialog_expire parameter 1.7. Set clean_interval parameter + 1.8. Set event_callback parameter + 1.9. Usage of event_route[topos:msg-outgoing] Chapter 1. Admin Guide @@ -62,6 +69,11 @@ Chapter 1. Admin Guide 3.5. branch_expire (int) 3.6. dialog_expire (int) 3.7. clean_interval (int) + 3.8. event_callback (str) + + 4. Event Routes + + 4.1. event_route[topos:msg-outgoing] 1. Overview @@ -102,6 +114,7 @@ Chapter 1. Admin Guide 3.5. branch_expire (int) 3.6. dialog_expire (int) 3.7. clean_interval (int) + 3.8. event_callback (str) 3.1. storage (str) @@ -188,3 +201,49 @@ modparam("topos", "dialog_expire", 3600) ... modparam("topos", "clean_interval", 30) ... + +3.8. event_callback (str) + + 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. + + The function receives a string parameter with the name of the event. + + Default value is 'empty' (no function is executed for events). + + Example 1.8. Set event_callback parameter +... +modparam("topos", "event_callback", "ksr_topos_event") +... +-- event callback function implemented in Lua +function ksr_topos_event(evname) + KSR.info("===== topos module triggered event: " .. evname .. "\n"); + return 1; +end +... + +4. Event Routes + + 4.1. event_route[topos:msg-outgoing] + +4.1. event_route[topos:msg-outgoing] + + It is executed before doing topology stripping processing for an + outgoing SIP message. If 'drop' is executed inside the event route, + then the module skips doing the topology hiding. + + Inside the event route the variables $sndto(ip), $sndto(port) and + $sndto(proto) point to the destination. The SIP message is not the one + to be sent out, but an internally generated one at startup, to avoid + reparsing the outgoing SIP message for the cases when topology hiding + is not wanted. + + Example 1.9. Usage of event_route[topos:msg-outgoing] +... +event_route[topos:msg-outgoing] { + if($sndto(ip)=="10.1.1.10") { + drop; + } +} +...