Browse Source

modules: readme files regenerated - dispatcher ... [skip ci]

Kamailio Dev 7 years ago
parent
commit
f665c7651d
1 changed files with 41 additions and 20 deletions
  1. 41 20
      src/modules/dispatcher/README

+ 41 - 20
src/modules/dispatcher/README

@@ -98,6 +98,7 @@ Julien Chavanton
               3.33. ds_timer_mode (int)
               3.34. event_callback (str)
               3.35. ds_attrs_none (int)
+              3.36. ds_db_extra_attrs (str)
 
         4. Functions
 
@@ -177,16 +178,17 @@ Julien Chavanton
    1.35. Set the “ds_timer_mode” parameter
    1.36. Set event_callback parameter
    1.37. Set the “ds_attrs_none” parameter
-   1.38. ds_select_dst usage
-   1.39. configuring load balancing with congestion detection
-   1.40. ds_select_domain usage
-   1.41. ds_select usage
-   1.42. ds_mark_dst usage
-   1.43. ds_list_exists usage
-   1.44. ds_is_from_list usage
-   1.45. ds_load_unset usage
-   1.46. dispatcher list file
-   1.47. Kamailio config script - sample dispatcher usage
+   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_mark_dst usage
+   1.44. ds_list_exists usage
+   1.45. ds_is_from_list usage
+   1.46. ds_load_unset usage
+   1.47. dispatcher list file
+   1.48. Kamailio config script - sample dispatcher usage
 
 Chapter 1. Admin Guide
 
@@ -235,6 +237,7 @@ Chapter 1. Admin Guide
         3.33. ds_timer_mode (int)
         3.34. event_callback (str)
         3.35. ds_attrs_none (int)
+        3.36. ds_db_extra_attrs (str)
 
    4. Functions
 
@@ -345,6 +348,7 @@ Chapter 1. Admin Guide
    3.33. ds_timer_mode (int)
    3.34. event_callback (str)
    3.35. ds_attrs_none (int)
+   3.36. ds_db_extra_attrs (str)
 
 3.1. list_file (string)
 
@@ -887,6 +891,23 @@ end
  modparam("dispatcher", "ds_attrs_none", 1)
  ...
 
+3.36. ds_db_extra_attrs (str)
+
+   Set a list of column names to be loaded from database dispatcher table
+   and be concatenated to 'attrs' field. The format is:
+   'aname1=cname1;aname2=cname2;...;anameN=cnameN'.
+
+   The 'anameX' is the attribute name and 'cnameX' is column name. The
+   additional columns must be added to database dispatcher table and their
+   type must be VARCHAR (string).
+
+   Default value is “empty”.
+
+   Example 1.38. Set the “ds_db_extra_attrs” parameter
+...
+modparam("dispatcher", "ds_db_extra_attrs", "socket=socket;pref=prefix")
+...
+
 4. Functions
 
    4.1. ds_select_dst(set, alg[, limit])
@@ -986,7 +1007,7 @@ end
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.38. ds_select_dst usage
+   Example 1.39. ds_select_dst usage
 ...
 ds_select_dst("1", "0");
 ...
@@ -996,7 +1017,7 @@ ds_select_dst("1", "$var(a)");
 ds_select_dst("1", "4", "3");
 ...
 
-   Example 1.39. configuring load balancing with congestion detection
+   Example 1.40. configuring load balancing with congestion detection
 ...
 # sample of SQL provisionning statements
 INSERT INTO "dispatcher"
@@ -1048,7 +1069,7 @@ DEST: {
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.40. ds_select_domain usage
+   Example 1.41. ds_select_domain usage
 ...
 $var(a) = 4;
 if(ds_select_domain("1", "$var(a)")) {
@@ -1072,7 +1093,7 @@ if(ds_select_domain("1", "$var(a)")) {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.41. ds_select usage
+   Example 1.42. ds_select usage
 ...
 $var(a) = 4;
 if(ds_select("1", "$var(a)")) {
@@ -1137,7 +1158,7 @@ if(ds_select("1", "$var(a)")) {
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.42. ds_mark_dst usage
+   Example 1.43. ds_mark_dst usage
 ...
 failure_route[tryagain] {
 ...
@@ -1156,7 +1177,7 @@ failure_route[tryagain] {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.43. ds_list_exists usage
+   Example 1.44. ds_list_exists usage
 ...
 if(ds_list_exists("10")) {
     ...
@@ -1199,7 +1220,7 @@ if(ds_list_exists("10")) {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.44. ds_is_from_list usage
+   Example 1.45. ds_is_from_list usage
 ...
 if(ds_is_from_list()) {
     ...
@@ -1233,7 +1254,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.45. ds_load_unset usage
+   Example 1.46. ds_load_unset usage
 ...
 route {
     ...
@@ -1407,7 +1428,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.46. dispatcher list file
+   Example 1.47. dispatcher list file
 ...
 #
 # dispatcher destination sets (groups)
@@ -1432,7 +1453,7 @@ r,opt)
 
    Next listing shows a sample config for using the dispatcher module.
 
-   Example 1.47. Kamailio config script - sample dispatcher usage
+   Example 1.48. Kamailio config script - sample dispatcher usage
 ...
 #!KAMAILIO
 #