Browse code

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

Kamailio Dev authored on 04/07/2022 13:46:14
Showing 2 changed files
... ...
@@ -50,6 +50,7 @@ Carsten Bock
50 50
               3.7. disable_time (integer)
51 51
               3.8. flush_on_reconnect (integer)
52 52
               3.9. allow_dynamic_nodes (integer)
53
+              3.10. debug (integer)
53 54
 
54 55
         4. Functions
55 56
 
... ...
@@ -69,9 +70,10 @@ Carsten Bock
69 70
    1.7. Set disable_time parameter
70 71
    1.8. Set flush_on_reconnect parameter
71 72
    1.9. Set allow_dynamic_nodes parameter
72
-   1.10. redis_cmd usage
73
-   1.11. redis_execute usage
74
-   1.12. redis_free usage
73
+   1.10. Set debug parameter
74
+   1.11. redis_cmd usage
75
+   1.12. redis_execute usage
76
+   1.13. redis_free usage
75 77
 
76 78
 Chapter 1. Admin Guide
77 79
 
... ...
@@ -94,6 +96,7 @@ Chapter 1. Admin Guide
94 96
         3.7. disable_time (integer)
95 97
         3.8. flush_on_reconnect (integer)
96 98
         3.9. allow_dynamic_nodes (integer)
99
+        3.10. debug (integer)
97 100
 
98 101
    4. Functions
99 102
 
... ...
@@ -138,6 +141,7 @@ Chapter 1. Admin Guide
138 141
    3.7. disable_time (integer)
139 142
    3.8. flush_on_reconnect (integer)
140 143
    3.9. allow_dynamic_nodes (integer)
144
+   3.10. debug (integer)
141 145
 
142 146
 3.1. server (str)
143 147
 
... ...
@@ -319,6 +323,18 @@ modparam("ndb_redis", "cluster", 1)
319 323
 modparam("ndb_redis", "allow_dynamic_nodes", 1)
320 324
 ...
321 325
 
326
+3.10. debug (integer)
327
+
328
+   Set the verbosity level for some of the log messages. It has to be a
329
+   log level value.
330
+
331
+   Default value is “3” (L_DBG).
332
+
333
+   Example 1.10. Set debug parameter
334
+...
335
+modparam("ndb_redis", "debug", 1)
336
+...
337
+
322 338
 4. Functions
323 339
 
324 340
    4.1. redis_cmd(srvname, command, ..., replyid)
... ...
@@ -359,7 +375,7 @@ modparam("ndb_redis", "allow_dynamic_nodes", 1)
359 375
    value. The key can be: rpl_str, rpl_arr, rpl_int, rpl_err, rpl_sts,
360 376
    rpl_nil.
361 377
 
362
-   Example 1.10. redis_cmd usage
378
+   Example 1.11. redis_cmd usage
363 379
 ...
364 380
 if(redis_cmd("srvN", "INCR cnt", "r")) {
365 381
     # success - the incremented value is in $redis(r=>value)
... ...
@@ -438,7 +454,7 @@ if (redis_cmd("srvN", "EXEC", "r")) {
438 454
    If cluster parameter is set to 1, this function will log an error and
439 455
    do nothing.
440 456
 
441
-   Example 1.11. redis_execute usage
457
+   Example 1.12. redis_execute usage
442 458
 ...
443 459
 After several redis command calls:
444 460
         redis_pipe_cmd("srvA", "SET foo bar", "r1");
... ...
@@ -486,7 +502,7 @@ d commands. The call is not necessary
486 502
    function. When ndb_redis module closes, all pending replies are freed
487 503
    automatically.
488 504
 
489
-   Example 1.12. redis_free usage
505
+   Example 1.13. redis_free usage
490 506
 ...
491 507
 After a redis command call:
492 508
         redis_cmd("srvN", "INCR cnt", "r");
... ...
@@ -143,11 +143,13 @@ Chapter 1. Admin Guide
143 143
    to be loaded (tune the module parameters if needed).
144 144
 
145 145
    It also works for SIP MESSAGE or other requests that do not create a
146
-   dialog -- record_route() must be used for them as well, the headers are
147
-   not going to be in the messages sent to the network, they are needed to
148
-   know local addresses used to communicate with each side. This module is
149
-   designed to work for presence (SUBSCRIBE-based) dialogs too. The
150
-   REGISTER and PUBLISH requests are skipped from processing by this
146
+   dialog (e.g., OPTIONS) -- record_route() must be used for them as well,
147
+   the headers are not going to be in the messages sent to the network,
148
+   they are needed to know local addresses used to communicate with each
149
+   side. This module is designed to work for presence (SUBSCRIBE-based)
150
+   dialogs too.
151
+
152
+   The REGISTER and PUBLISH requests are skipped from processing by this
151 153
    module, expected to be terminated on a local SIP server.
152 154
 
153 155
 2. Dependencies