فهرست منبع

app_lua: sync'ed the list of exported modules to lua

Daniel-Constantin Mierla 13 سال پیش
والد
کامیت
098d93bd5c
2فایلهای تغییر یافته به همراه86 افزوده شده و 10 حذف شده
  1. 24 8
      modules/app_lua/README
  2. 62 2
      modules/app_lua/doc/app_lua_admin.xml

+ 24 - 8
modules/app_lua/README

@@ -10,7 +10,7 @@ Daniel-Constantin Mierla
 
 
    <[email protected]>
    <[email protected]>
 
 
-   Copyright © 2010 Daniel-Constantin Mierla (asipto.com)
+   Copyright © 2010 Daniel-Constantin Mierla (asipto.com)
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -116,7 +116,7 @@ Chapter 1. Admin Guide
    use lua_run(function, params) to execute a function from the script at
    use lua_run(function, params) to execute a function from the script at
    runtime.
    runtime.
 
 
-   Default value is “null�.
+   Default value is "null".
 
 
    Example 1.1. Set load parameter
    Example 1.1. Set load parameter
 ...
 ...
@@ -127,24 +127,40 @@ modparam("app_lua", "load", "/usr/local/etc/kamailio/lua/myscript.lua")
 
 
    Use this function to register optional SIP Router submodules to Lua.
    Use this function to register optional SIP Router submodules to Lua.
    Available submodules are:
    Available submodules are:
+     * alias_db - register functions from alias_db module under
+       'sr.alias_db'.
      * auth - register functions from auth module under 'sr.auth'.
      * auth - register functions from auth module under 'sr.auth'.
      * auth_db - register functions from auth_db module under
      * auth_db - register functions from auth_db module under
        'sr.auth_db'.
        'sr.auth_db'.
      * dispatcher - register functions from dispatcher module under
      * dispatcher - register functions from dispatcher module under
        'sr.dispatcher'.
        'sr.dispatcher'.
      * maxfwd - register functions from maxfwd module under 'sr.maxfwd'.
      * maxfwd - register functions from maxfwd module under 'sr.maxfwd'.
+     * msilo - register functions from msilo module under 'sr.msilo'.
+     * presence - register functions from presence module under
+       'sr.presence'.
+     * presence_xml - register functions from presence_xml module under
+       'sr.presence_xml'.
+     * pua_usrloc - register functions from pua_usrloc module under
+       'sr.pua_usrloc'.
      * registrar - register functions from registrar module under
      * registrar - register functions from registrar module under
        'sr.registrar'.
        'sr.registrar'.
+     * rls - register functions from rls module under 'sr.rls'.
      * rr - register functions from rr module under 'sr.rr'.
      * rr - register functions from rr module under 'sr.rr'.
-     * sqlops - register functions from sqlops module under 'sr.sqlops'.
+     * sanity - register functions from sanity module under 'sr.sanity'.
+     * sdpops - register functions from sdpops module under 'sr.sdpops'.
+     * siputils - register functions from siputils module under
+       'sr.siputils'.
      * sl - register functions from sl module under 'sr.sl'.
      * sl - register functions from sl module under 'sr.sl'.
+     * sqlops - register functions from sqlops module under 'sr.sqlops'.
+     * textops - register functions from textops module under
+       'sr.textops'.
      * tm - register functions from tm module under 'sr.tm'.
      * tm - register functions from tm module under 'sr.tm'.
      * xhttp - register functions from xhttp module under 'sr.xhttp'.
      * xhttp - register functions from xhttp module under 'sr.xhttp'.
 
 
    Note that 'sr', 'sr.hdr' and 'sr.pv' modules are always registered to
    Note that 'sr', 'sr.hdr' and 'sr.pv' modules are always registered to
    Lua.
    Lua.
 
 
-   Default value is “null�.
+   Default value is "null".
 
 
    Example 1.2. Set register parameter
    Example 1.2. Set register parameter
 ...
 ...
@@ -158,7 +174,7 @@ modparam("app_lua", "register", "sl")
    4.3. lua_run(function, params)
    4.3. lua_run(function, params)
    4.4. lua_runstring(script)
    4.4. lua_runstring(script)
 
 
-4.1.  lua_dofile(path)
+4.1. lua_dofile(path)
 
 
    Execute the Lua script stored in 'path'. The parameter can be a string
    Execute the Lua script stored in 'path'. The parameter can be a string
    with pseudo-variables evaluated at runtime.
    with pseudo-variables evaluated at runtime.
@@ -168,7 +184,7 @@ modparam("app_lua", "register", "sl")
 lua_dofile("/usr/local/etc/kamailio/lua/myscript.lua");
 lua_dofile("/usr/local/etc/kamailio/lua/myscript.lua");
 ...
 ...
 
 
-4.2.  lua_dostring(script)
+4.2. lua_dostring(script)
 
 
    Execute the Lua script stored in parameter. The parameter can be a
    Execute the Lua script stored in parameter. The parameter can be a
    string with pseudo-variables.
    string with pseudo-variables.
@@ -181,7 +197,7 @@ if(!lua_dostring("sr.log([[err]], [[----------- Hello World from $fU\n]])"))
 }
 }
 ...
 ...
 
 
-4.3.  lua_run(function, params)
+4.3. lua_run(function, params)
 
 
    Execute the Lua function 'func' giving params as parameters. There can
    Execute the Lua function 'func' giving params as parameters. There can
    be up to 3 string parameters. The function must exist in the script
    be up to 3 string parameters. The function must exist in the script
@@ -198,7 +214,7 @@ if(!lua_run("sr_append_fu_to_reply"))
 lua_run("lua_funcx", "$rU", "2");
 lua_run("lua_funcx", "$rU", "2");
 ...
 ...
 
 
-4.4.  lua_runstring(script)
+4.4. lua_runstring(script)
 
 
    Execute the Lua script stored in parameter. The parameter can be a
    Execute the Lua script stored in parameter. The parameter can be a
    string with pseudo-variables. The script is executed in Lua context
    string with pseudo-variables. The script is executed in Lua context

+ 62 - 2
modules/app_lua/doc/app_lua_admin.xml

@@ -109,6 +109,12 @@ modparam("app_lua", "load", "/usr/local/etc/kamailio/lua/myscript.lua")
 			to Lua. Available submodules are:
 			to Lua. Available submodules are:
 	    </para>
 	    </para>
 	    	<itemizedlist>
 	    	<itemizedlist>
+		    <listitem>
+			<para>
+				<emphasis>alias_db</emphasis> - register functions from
+				alias_db module under 'sr.alias_db'.
+			</para>
+		    </listitem>
 		    <listitem>
 		    <listitem>
 			<para>
 			<para>
 				<emphasis>auth</emphasis> - register functions from auth module
 				<emphasis>auth</emphasis> - register functions from auth module
@@ -133,12 +139,42 @@ modparam("app_lua", "load", "/usr/local/etc/kamailio/lua/myscript.lua")
 				module under 'sr.maxfwd'.
 				module under 'sr.maxfwd'.
 			</para>
 			</para>
 		    </listitem>
 		    </listitem>
+		    <listitem>
+			<para>
+				<emphasis>msilo</emphasis> - register functions from
+				msilo module under 'sr.msilo'.
+			</para>
+		    </listitem>
+		    <listitem>
+			<para>
+				<emphasis>presence</emphasis> - register functions from
+				presence module under 'sr.presence'.
+			</para>
+		    </listitem>
+		    <listitem>
+			<para>
+				<emphasis>presence_xml</emphasis> - register functions from
+				presence_xml module under 'sr.presence_xml'.
+			</para>
+		    </listitem>
+		    <listitem>
+			<para>
+				<emphasis>pua_usrloc</emphasis> - register functions from
+				pua_usrloc module under 'sr.pua_usrloc'.
+			</para>
+		    </listitem>
 		    <listitem>
 		    <listitem>
 			<para>
 			<para>
 				<emphasis>registrar</emphasis> - register functions from
 				<emphasis>registrar</emphasis> - register functions from
 				registrar module under 'sr.registrar'.
 				registrar module under 'sr.registrar'.
 			</para>
 			</para>
 		    </listitem>
 		    </listitem>
+		    <listitem>
+			<para>
+				<emphasis>rls</emphasis> - register functions from
+				rls module under 'sr.rls'.
+			</para>
+		    </listitem>
 		    <listitem>
 		    <listitem>
 			<para>
 			<para>
 				<emphasis>rr</emphasis> - register functions from rr module
 				<emphasis>rr</emphasis> - register functions from rr module
@@ -147,8 +183,20 @@ modparam("app_lua", "load", "/usr/local/etc/kamailio/lua/myscript.lua")
 		    </listitem>
 		    </listitem>
 		    <listitem>
 		    <listitem>
 			<para>
 			<para>
-				<emphasis>sqlops</emphasis> - register functions from sqlops
-				module under 'sr.sqlops'.
+				<emphasis>sanity</emphasis> - register functions from sanity
+				module under 'sr.sanity'.
+			</para>
+		    </listitem>
+		    <listitem>
+			<para>
+				<emphasis>sdpops</emphasis> - register functions from
+				sdpops module under 'sr.sdpops'.
+			</para>
+		    </listitem>
+		    <listitem>
+			<para>
+				<emphasis>siputils</emphasis> - register functions from
+				siputils module under 'sr.siputils'.
 			</para>
 			</para>
 		    </listitem>
 		    </listitem>
 		    <listitem>
 		    <listitem>
@@ -157,6 +205,18 @@ modparam("app_lua", "load", "/usr/local/etc/kamailio/lua/myscript.lua")
 				under 'sr.sl'.
 				under 'sr.sl'.
 			</para>
 			</para>
 		    </listitem>
 		    </listitem>
+		    <listitem>
+			<para>
+				<emphasis>sqlops</emphasis> - register functions from sqlops
+				module under 'sr.sqlops'.
+			</para>
+		    </listitem>
+		    <listitem>
+			<para>
+				<emphasis>textops</emphasis> - register functions from
+				textops module under 'sr.textops'.
+			</para>
+		    </listitem>
 		    <listitem>
 		    <listitem>
 			<para>
 			<para>
 				<emphasis>tm</emphasis> - register functions from tm module
 				<emphasis>tm</emphasis> - register functions from tm module