User Tools
devel:config-engines
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | Last revision Both sides next revision | ||
|
devel:config-engines [2016/05/03 19:04] miconda |
devel:config-engines [2017/01/10 22:41] miconda |
||
|---|---|---|---|
| Line 5: | Line 5: | ||
| Starting with v5.0.0, the routing blocks can be written in some other (well known) scripting languages and run via their embedded interpreters inside Kamailio. Known to work: | Starting with v5.0.0, the routing blocks can be written in some other (well known) scripting languages and run via their embedded interpreters inside Kamailio. Known to work: | ||
| + | * JavaScript - implemented by app_jsdt module, as " | ||
| * Lua - implemented by app_lua module, as " | * Lua - implemented by app_lua module, as " | ||
| * Python - implemented by app_python module, as " | * Python - implemented by app_python module, as " | ||
| Line 129: | Line 130: | ||
| * **sr** - provided by the old way of exporting functions to Lua (https:// | * **sr** - provided by the old way of exporting functions to Lua (https:// | ||
| - | * **KSR** - provided via KEMI interface | + | * **KSR** - provided via KEMI interface. The functions exported to KEMI are accessible as KSR.submodule.function(...). If submodule name is empty (reserved for core functions), then they are available as KSR.function(...). |
| ==== Lua Embedded Config Example ==== | ==== Lua Embedded Config Example ==== | ||
| Line 267: | Line 269: | ||
| * **Router** - provided by the old way of exporting functions to Python (https:// | * **Router** - provided by the old way of exporting functions to Python (https:// | ||
| - | * **KSR** - provided via KEMI interface (not many functions exported at this moment, but expected to take over all **Router** module). The functions exported to KEMI are accessible as KSR.submodule.function(...). If submodule name is empty (reserved for core functions), then they are available as KSR.function(...). | + | * **KSR** - provided via KEMI. The functions exported to KEMI are accessible as KSR.submodule.function(...). If submodule name is empty (reserved for core functions), then they are available as KSR.function(...). |
| Line 386: | Line 388: | ||
| return 1; | return 1; | ||
| </ | </ | ||
| + | |||
| + | ===== JavaScript Config KEMI Engine ===== | ||
| + | |||
| + | The **app_jsdt** module must be loaded and the JavaScript script with routing logic must be set to its **load** parameter. | ||
| + | |||
| + | Inside the JavaScript script, following functions are relevant: | ||
| + | |||
| + | * **ksr_request_route()** - is executed by Kamailio core every time a SIP request is received. If this function is not defined, then Kamailio will write error messages. This is equivalent of request_route {} from kamailio.cfg. | ||
| + | * **ksr_reply_route()** - is executed by Kamailio core every time a SIP Response (reply) is received. If this function is not defined, then Kamailio will not write error messages. This is equivalent of reply_route {} from kamailio.cfg. | ||
| + | * **ksr_onsend_route()** - is executed by Kamailio core every time a SIP request (and optionally for a response) is sent out. If this function is not defined, then Kamailio will not write error messages. This is equivalent of onsend_route {} from kamailio.cfg. | ||
| + | * branch route callback - the name of the Lua function to be executed instead of a branch route has to be provided as parameter to KSR.tm.t_on_branch(...) | ||
| + | * onreply route callback - the name of the Lua function to be executed instead of an onreply route has to be provided as parameter to KSR.tm.t_on_reply(...) | ||
| + | * failure route callback - the name of the Lua function to be executed instead of a failure route has to be provided as parameter to KSR.tm.t_on_failure(...) | ||
| + | * branch failure route callback - the name of the Lua function to be executed instead of an event route for branch failure has to be provided as parameter to KSR.tm.t_on_branch_failure(...) | ||
| + | * TBD: the options for specific event_route blocks. Meanwhile, should work using hybrid configuration with request_route/ | ||
| + | |||
| + | The following objects are available inside the Lua script: | ||
| + | |||
| + | * **KSR** - provided via KEMI interface. The functions exported to KEMI are accessible as KSR.submodule.function(...). If submodule name is empty (reserved for core functions), then they are available as KSR.function(...). | ||
| ===== Basic IP Telephony Config Example ===== | ===== Basic IP Telephony Config Example ===== | ||
| Line 407: | Line 428: | ||
| * https:// | * https:// | ||
| + | If you define WITH_CFGJSDT inside **kamailio-basic-kemi.cfg** or provide the command line parameter **-A WITH_CFGJSDT**, | ||
| + | |||
| + | * https:// | ||
| If you define WITH_CFGPYTHON inside **kamailio-basic-kemi.cfg** or provide the command line parameter **-A WITH_CFGPYTHON**, | If you define WITH_CFGPYTHON inside **kamailio-basic-kemi.cfg** or provide the command line parameter **-A WITH_CFGPYTHON**, | ||
| Line 412: | Line 436: | ||
| * https:// | * https:// | ||
| - | Combining **kamailio-basic-kemi.cfg** with **kamailio-basic-kemi-native.cfg** results more or less in the **kamailio-basic.cfg** from the **etc/** folder in Kamailio source tree. The Lua and Python scripts are offering the same features, but written in another language. | + | Combining **kamailio-basic-kemi.cfg** with **kamailio-basic-kemi-native.cfg** results more or less in the **kamailio-basic.cfg** from the **etc/** folder in Kamailio source tree. The Lua, JavaScript |
| Note that you need to copy these files at the location of the configuration file for your Kamailio configuration and eventually adjust the paths to them inside **kamailio-basic-kemi.cfg**. | Note that you need to copy these files at the location of the configuration file for your Kamailio configuration and eventually adjust the paths to them inside **kamailio-basic-kemi.cfg**. | ||
| Line 434: | Line 458: | ||
| <code c> | <code c> | ||
| / | / | ||
| + | </ | ||
| + | |||
| + | To start it with JavaScript routing blocks: | ||
| + | |||
| + | <code c> | ||
| + | / | ||
| </ | </ | ||
| If you want to print the log messages to the terminal, add the extra parameters **-E -e -ddd** - this will print up to debug level which can be too verbose. Using up to info level can be better, use the extra parameters | If you want to print the log messages to the terminal, add the extra parameters **-E -e -ddd** - this will print up to debug level which can be too verbose. Using up to info level can be better, use the extra parameters | ||
| - | When you have at least log level info, with kamailio-basic-kemi.cfg you will notice that a log message is printed showing the duration in microseconds of executing the main routing blocks, no matter they were in native language, Lua or Python. If the logs were printed to the terminal, they look like: | + | When you have at least log level info, with kamailio-basic-kemi.cfg you will notice that a log message is printed showing the duration in microseconds of executing the main routing blocks, no matter they were in native language, Lua, JavaScript |
| < | < | ||
| Line 448: | Line 478: | ||
| * NAT - for native interpreter | * NAT - for native interpreter | ||
| * LUA - for LUA | * LUA - for LUA | ||
| + | * JSC - for JavaScript | ||
| * PYT - for Python | * PYT - for Python | ||
devel/config-engines.txt · Last modified: 2017/11/20 14:31 by miconda
Page Tools
