modules: readme files regenerated - app_lua ... [skip ci]
authorKamailio Dev <kamailio.dev@kamailio.org>
Sun, 10 Feb 2019 14:46:42 +0000 (15:46 +0100)
committerKamailio Dev <kamailio.dev@kamailio.org>
Sun, 10 Feb 2019 14:46:42 +0000 (15:46 +0100)
src/modules/app_lua/README
src/modules/dispatcher/README

index d631c1d..c926de9 100644 (file)
@@ -158,7 +158,14 @@ modparam("app_lua", "load", "/usr/local/etc/kamailio/lua/myscript.lua")
 
 3.2. register (string)
 
-   Use this function to register optional SIP Router submodules to Lua.
+   NOTE: Since Kamailio v5.0, KEMI exports are available in Lua script
+   under KSR module. These exports cover most of the modules, a lot more
+   that those listed next. The KEMI exports are the recommended to be
+   used, the old 'sr' module might be obsoleted soon. To read more about
+   KEMI exports and available KSR submodules, see:
+     * http://kamailio.org/docs/tutorials/devel/kamailio-kemi-framework/
+
+   Use this parameter to register optional Kamailio submodules to Lua.
    Available submodules are:
      * alias_db - register functions from alias_db module under
        'sr.alias_db'.
index 766e639..f65a72f 100644 (file)
@@ -99,6 +99,7 @@ Julien Chavanton
               3.34. event_callback (str)
               3.35. ds_attrs_none (int)
               3.36. ds_db_extra_attrs (str)
+              3.37. ds_load_mode (int)
 
         4. Functions
 
@@ -181,17 +182,18 @@ Julien Chavanton
    1.36. Set event_callback parameter
    1.37. Set the “ds_attrs_none” parameter
    1.38. Set the “ds_db_extra_attrs” parameter
-   1.39. ds_select_dst usage
-   1.40. configuring load balancing with congestion detection
-   1.41. ds_select_domain usage
-   1.42. ds_select usage
-   1.43. ds_select_routes usage
-   1.44. ds_mark_dst usage
-   1.45. ds_list_exists usage
-   1.46. ds_is_from_list usage
-   1.47. ds_load_unset usage
-   1.48. dispatcher list file
-   1.49. Kamailio config script - sample dispatcher usage
+   1.39. Set the “ds_load_mode” parameter
+   1.40. ds_select_dst usage
+   1.41. configuring load balancing with congestion detection
+   1.42. ds_select_domain usage
+   1.43. ds_select usage
+   1.44. ds_select_routes usage
+   1.45. ds_mark_dst usage
+   1.46. ds_list_exists usage
+   1.47. ds_is_from_list usage
+   1.48. ds_load_unset usage
+   1.49. dispatcher list file
+   1.50. Kamailio config script - sample dispatcher usage
 
 Chapter 1. Admin Guide
 
@@ -241,6 +243,7 @@ Chapter 1. Admin Guide
         3.34. event_callback (str)
         3.35. ds_attrs_none (int)
         3.36. ds_db_extra_attrs (str)
+        3.37. ds_load_mode (int)
 
    4. Functions
 
@@ -354,6 +357,7 @@ Chapter 1. Admin Guide
    3.34. event_callback (str)
    3.35. ds_attrs_none (int)
    3.36. ds_db_extra_attrs (str)
+   3.37. ds_load_mode (int)
 
 3.1. list_file (string)
 
@@ -918,6 +922,19 @@ end
 modparam("dispatcher", "ds_db_extra_attrs", "socket=socket;pref=prefix")
 ...
 
+3.37. ds_load_mode (int)
+
+   If set to 1, the module throws error when failing to add a destination
+   address (e.g., invalid URI). If set to 0, it skips the failing address
+   and continues with the next ones.
+
+   Default value is “0”.
+
+   Example 1.39. Set the “ds_load_mode” parameter
+ ...
+ modparam("dispatcher", "ds_load_mode", 1)
+ ...
+
 4. Functions
 
    4.1. ds_select_dst(set, alg[, limit])
@@ -1018,7 +1035,7 @@ modparam("dispatcher", "ds_db_extra_attrs", "socket=socket;pref=prefix")
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.39. ds_select_dst usage
+   Example 1.40. ds_select_dst usage
 ...
 ds_select_dst("1", "0");
 ...
@@ -1028,7 +1045,7 @@ ds_select_dst("1", "$var(a)");
 ds_select_dst("1", "4", "3");
 ...
 
-   Example 1.40. configuring load balancing with congestion detection
+   Example 1.41. configuring load balancing with congestion detection
 ...
 # sample of SQL provisionning statements
 INSERT INTO "dispatcher"
@@ -1080,7 +1097,7 @@ DEST: {
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.41. ds_select_domain usage
+   Example 1.42. ds_select_domain usage
 ...
 $var(a) = 4;
 if(ds_select_domain("1", "$var(a)")) {
@@ -1104,7 +1121,7 @@ if(ds_select_domain("1", "$var(a)")) {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.42. ds_select usage
+   Example 1.43. ds_select usage
 ...
 $var(a) = 4;
 if(ds_select("1", "$var(a)")) {
@@ -1147,7 +1164,7 @@ if(ds_select("1", "$var(a)")) {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.43. ds_select_routes usage
+   Example 1.44. ds_select_routes usage
 ...
 $var(alg) = 4;
 $var(limit) = 8;
@@ -1222,7 +1239,7 @@ failure_route[REROUTE] {
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.44. ds_mark_dst usage
+   Example 1.45. ds_mark_dst usage
 ...
 failure_route[tryagain] {
 ...
@@ -1241,7 +1258,7 @@ failure_route[tryagain] {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.45. ds_list_exists usage
+   Example 1.46. ds_list_exists usage
 ...
 if(ds_list_exists("10")) {
     ...
@@ -1284,7 +1301,7 @@ if(ds_list_exists("10")) {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.46. ds_is_from_list usage
+   Example 1.47. ds_is_from_list usage
 ...
 if(ds_is_from_list()) {
     ...
@@ -1318,7 +1335,7 @@ if(ds_is_from_list("10", "3", "sip:127.0.0.1:5080")) {
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and ONREPLY_ROUTE.
 
-   Example 1.47. ds_load_unset usage
+   Example 1.48. ds_load_unset usage
 ...
 route {
     ...
@@ -1540,7 +1557,7 @@ setid(int) destination(sip uri) flags(int,opt) priority(int,opt) attrs(str,opt)
    For database, each element of a line resides in a different column.
    Next is a dispatcher.list file example:
 
-   Example 1.48. dispatcher list file
+   Example 1.49. dispatcher list file
 ...
 #
 # dispatcher destination sets (groups)
@@ -1565,7 +1582,7 @@ r,opt)
 
    Next listing shows a sample config for using the dispatcher module.
 
-   Example 1.49. Kamailio config script - sample dispatcher usage
+   Example 1.50. Kamailio config script - sample dispatcher usage
 ...
 #!KAMAILIO
 #