Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

app_lua: LUAJIT variable to build agains LuaJIT compiler #1384

Merged
merged 3 commits into from Dec 22, 2017
Merged

app_lua: LUAJIT variable to build agains LuaJIT compiler #1384

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
41ff35e
app_lua: LUAJIT variable to build agains LuaJIT compiler
Dec 22, 2017
55e3b72
app_lua: update doc about LUAJIT variable and building against LuaJIT…
Dec 22, 2017
02723aa
app_lua: README update
Dec 22, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
41 changes: 27 additions & 14 deletions src/modules/app_lua/README
View file
Open in desktop
Expand Up @@ -46,13 +46,14 @@ Daniel-Constantin Mierla

List of Examples

1.1. Set load parameter
1.2. Set register parameter
1.3. Set reload parameter
1.4. lua_dofile usage
1.5. lua_dostring usage
1.6. lua_run usage
1.7. lua_runstring usage
1.1. Build against LuaJIT libraries
1.2. Set load parameter
1.3. Set register parameter
1.4. Set reload parameter
1.5. lua_dofile usage
1.6. lua_dostring usage
1.7. lua_run usage
1.8. lua_runstring usage

Chapter 1. Admin Guide

Expand Down Expand Up @@ -120,6 +121,18 @@ Chapter 1. Admin Guide
running Kamailio with this module loaded:
* liblua5.1-dev - Lua devel library.

This module can be compiled against LuaJIT compiler (instead of
standard Lua). Then this library is needed:
* libluajit-5.1-dev - LuaJIT devel library.

To enable that, LUAJIT variable has to be set.

Example 1.1. Build against LuaJIT libraries
E.g: $ LUAJIT="yes" make modules modules=modules/app_lua

(Warning: LuaJIT version is 5.1, so scripts prepared for higher Lua
versions may not work with LuaJIT)

3. Parameters

3.1. load (string)
Expand All @@ -134,7 +147,7 @@ Chapter 1. Admin Guide

Default value is “null”.

Example 1.1. Set load parameter
Example 1.2. Set load parameter
...
modparam("app_lua", "load", "/usr/local/etc/kamailio/lua/myscript.lua")
...
Expand Down Expand Up @@ -178,7 +191,7 @@ modparam("app_lua", "load", "/usr/local/etc/kamailio/lua/myscript.lua")

Default value is “null”.

Example 1.2. Set register parameter
Example 1.3. Set register parameter
...
modparam("app_lua", "register", "sl")
...
Expand All @@ -190,7 +203,7 @@ modparam("app_lua", "register", "sl")

Default value is “0 (off)”.

Example 1.3. Set reload parameter
Example 1.4. Set reload parameter
...
modparam("app_lua", "reload", 1)
...
Expand All @@ -207,7 +220,7 @@ modparam("app_lua", "reload", 1)
Execute the Lua script stored in 'path'. The parameter can be a string
with pseudo-variables evaluated at runtime.

Example 1.4. lua_dofile usage
Example 1.5. lua_dofile usage
...
lua_dofile("/usr/local/etc/kamailio/lua/myscript.lua");
...
Expand All @@ -217,7 +230,7 @@ lua_dofile("/usr/local/etc/kamailio/lua/myscript.lua");
Execute the Lua script stored in parameter. The parameter can be a
string with pseudo-variables.

Example 1.5. lua_dostring usage
Example 1.6. lua_dostring usage
...
if(!lua_dostring("sr.log([[err]], [[----------- Hello World from $fU\n]])"))
{
Expand All @@ -232,7 +245,7 @@ if(!lua_dostring("sr.log([[err]], [[----------- Hello World from $fU\n]])"))
loaded at startup via parameter 'load'. Parameters can be strings with
pseudo-variables that are evaluated at runtime.

Example 1.6. lua_run usage
Example 1.7. lua_run usage
...
if(!lua_run("sr_append_fu_to_reply"))
{
Expand All @@ -248,7 +261,7 @@ lua_run("lua_funcx", "$rU", "2");
string with pseudo-variables. The script is executed in Lua context
specific to loaded Lua files at startup.

Example 1.7. lua_runstring usage
Example 1.8. lua_runstring usage
...
if(!lua_runstring("sr.log([[err]], [[----------- Hello World from $fU\n]])"))
{
Expand Down
18 changes: 18 additions & 0 deletions src/modules/app_lua/doc/app_lua_admin.xml
View file
Open in desktop
Expand Up @@ -75,6 +75,24 @@
</para>
</listitem>
</itemizedlist>
<para>
This module can be compiled against LuaJIT compiler (instead of
standard Lua). Then this library is needed:
<itemizedlist>
<listitem>
<emphasis>libluajit-5.1-dev</emphasis> - LuaJIT devel library.
</listitem>
</itemizedlist>
<para>
To enable that, LUAJIT variable has to be set.
<example>
<title>Build against LuaJIT libraries</title>
E.g: $ LUAJIT="yes" make modules modules=modules/app_lua
</example>
(Warning: LuaJIT version is 5.1, so scripts prepared for higher Lua versions
may not work with LuaJIT)
</para>
</para>
</para>
</section>
</section>
Expand Down