浏览代码

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

Kamailio Dev 7 年之前
父节点
当前提交
7725dc8673
共有 1 个文件被更改,包括 32 次插入6 次删除
  1. 32 6
      src/modules/ndb_redis/README

+ 32 - 6
src/modules/ndb_redis/README

@@ -49,6 +49,7 @@ Carsten Bock
               3.6. allowed_timeouts (integer)
               3.7. disable_time (integer)
               3.8. flush_on_reconnect (integer)
+              3.9. allow_dynamic_nodes (integer)
 
         4. Functions
 
@@ -67,9 +68,10 @@ Carsten Bock
    1.6. Set allowed_timeots parameter
    1.7. Set disable_time parameter
    1.8. Set flush_on_reconnect parameter
-   1.9. redis_cmd usage
-   1.10. redis_execute usage
-   1.11. redis_free usage
+   1.9. Set allow_dynamic_nodes parameter
+   1.10. redis_cmd usage
+   1.11. redis_execute usage
+   1.12. redis_free usage
 
 Chapter 1. Admin Guide
 
@@ -91,6 +93,7 @@ Chapter 1. Admin Guide
         3.6. allowed_timeouts (integer)
         3.7. disable_time (integer)
         3.8. flush_on_reconnect (integer)
+        3.9. allow_dynamic_nodes (integer)
 
    4. Functions
 
@@ -134,6 +137,7 @@ Chapter 1. Admin Guide
    3.6. allowed_timeouts (integer)
    3.7. disable_time (integer)
    3.8. flush_on_reconnect (integer)
+   3.9. allow_dynamic_nodes (integer)
 
 3.1. server (str)
 
@@ -284,6 +288,28 @@ modparam("ndb_redis", "disable_time", 30)
 modparam("ndb_redis", "flush_on_reconnect", 1)
 ...
 
+3.9. allow_dynamic_nodes (integer)
+
+   If set to 1, the module will connect to servers indicated in the
+   "MOVED" reply, even if they are not specified at startup.
+
+   When “cluster” is enabled the module supports redirections ("MOVED")
+   replies. Set “allow_dynamic_nodes” to 1 to avoid listing all the nodes
+   at startup. You can only list one node, e.g. by using a DNS name for
+   the cluster instead of an IP address. The module will add dynamically
+   the new nodes as the MOVED replies are received. Only works if
+   “cluster” is set to 1.
+
+   Default value is “0” (disabled).
+
+   Example 1.9. Set allow_dynamic_nodes parameter
+...
+modparam("ndb_redis", "server", "name=redis_cluster;addr=127.0.0.1;port=26008")
+...
+modparam("ndb_redis", "cluster", 1)
+modparam("ndb_redis", "allow_dynamic_nodes", 1)
+...
+
 4. Functions
 
    4.1. redis_cmd(srvname, command, ..., replyid)
@@ -320,7 +346,7 @@ modparam("ndb_redis", "flush_on_reconnect", 1)
    The first value[n] references the element in the first array, while the
    next key references an element of the referenced array.
 
-   Example 1.9. redis_cmd usage
+   Example 1.10. redis_cmd usage
 ...
 if(redis_cmd("srvN", "INCR cnt", "r")) {
     # success - the incremented value is in $redis(r=>value)
@@ -399,7 +425,7 @@ if (redis_cmd("srvN", "EXEC", "r")) {
    If cluster parameter is set to 1, this function will log an error and
    do nothing.
 
-   Example 1.10. redis_execute usage
+   Example 1.11. redis_execute usage
 ...
 After several redis command calls:
         redis_pipe_cmd("srvA", "SET foo bar", "r1");
@@ -447,7 +473,7 @@ d commands. The call is not necessary
    function. When ndb_redis module closes, all pending replies are freed
    automatically.
 
-   Example 1.11. redis_free usage
+   Example 1.12. redis_free usage
 ...
 After a redis command call:
         redis_cmd("srvN", "INCR cnt", "r");