Browse code

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

Kamailio Dev authored on 21/04/2021 09:31:26
Showing 1 changed files
... ...
@@ -36,12 +36,13 @@ Charles Chance
36 36
         3. Parameters
37 37
 
38 38
               3.1. server_address(str)
39
-              3.2. notification_address(str)
40
-              3.3. notification_channel(str)
41
-              3.4. multi_notify(int)
42
-              3.5. num_workers(int)
43
-              3.6. worker_usleep(int)
44
-              3.7. ping_interval(int)
39
+              3.2. server_socket(str)
40
+              3.3. notification_address(str)
41
+              3.4. notification_channel(str)
42
+              3.5. multi_notify(int)
43
+              3.6. num_workers(int)
44
+              3.7. worker_usleep(int)
45
+              3.8. ping_interval(int)
45 46
 
46 47
         4. Functions
47 48
 
... ...
@@ -72,19 +73,20 @@ Charles Chance
72 73
 
73 74
    1.1. KDMQ Request Example
74 75
    1.2. Set server_address parameter
75
-   1.3. Set notification_address parameter
76
-   1.4. Set notification_channel parameter
77
-   1.5. Set multi_notify parameter
78
-   1.6. Set num_workers parameter
79
-   1.7. Set worker_usleep parameter
80
-   1.8. Set ping_interval parameter
81
-   1.9. dmq_handle_message usage
82
-   1.10. dmq_process_message usage
83
-   1.11. dmq_send_message usage
84
-   1.12. dmq_bcast_message usage
85
-   1.13. dmq_t_replicate usage
86
-   1.14. dmq_is_from_node usage
87
-   1.15. dmq.list_nodes usage
76
+   1.3. Set server_socket parameter
77
+   1.4. Set notification_address parameter
78
+   1.5. Set notification_channel parameter
79
+   1.6. Set multi_notify parameter
80
+   1.7. Set num_workers parameter
81
+   1.8. Set worker_usleep parameter
82
+   1.9. Set ping_interval parameter
83
+   1.10. dmq_handle_message usage
84
+   1.11. dmq_process_message usage
85
+   1.12. dmq_send_message usage
86
+   1.13. dmq_bcast_message usage
87
+   1.14. dmq_t_replicate usage
88
+   1.15. dmq_is_from_node usage
89
+   1.16. dmq.list_nodes usage
88 90
    2.1. dmq_api_t structure
89 91
    2.2. register_dmq_peer usage
90 92
    2.3. bcast_message usage
... ...
@@ -103,12 +105,13 @@ Chapter 1. Admin Guide
103 105
    3. Parameters
104 106
 
105 107
         3.1. server_address(str)
106
-        3.2. notification_address(str)
107
-        3.3. notification_channel(str)
108
-        3.4. multi_notify(int)
109
-        3.5. num_workers(int)
110
-        3.6. worker_usleep(int)
111
-        3.7. ping_interval(int)
108
+        3.2. server_socket(str)
109
+        3.3. notification_address(str)
110
+        3.4. notification_channel(str)
111
+        3.5. multi_notify(int)
112
+        3.6. num_workers(int)
113
+        3.7. worker_usleep(int)
114
+        3.8. ping_interval(int)
112 115
 
113 116
    4. Functions
114 117
 
... ...
@@ -201,17 +204,21 @@ sip:192.168.40.17:5060;status=active
201 204
 3. Parameters
202 205
 
203 206
    3.1. server_address(str)
204
-   3.2. notification_address(str)
205
-   3.3. notification_channel(str)
206
-   3.4. multi_notify(int)
207
-   3.5. num_workers(int)
208
-   3.6. worker_usleep(int)
209
-   3.7. ping_interval(int)
207
+   3.2. server_socket(str)
208
+   3.3. notification_address(str)
209
+   3.4. notification_channel(str)
210
+   3.5. multi_notify(int)
211
+   3.6. num_workers(int)
212
+   3.7. worker_usleep(int)
213
+   3.8. ping_interval(int)
210 214
 
211 215
 3.1. server_address(str)
212 216
 
213
-   The local server address. This is the interface over which the DMQ
214
-   engine will send/receive messages.
217
+   The local server address. This is the addres with which the local DMQ
218
+   node joins the servers group to send/receive messages.
219
+
220
+   Note: if server_socket is not set, then this address has to match a
221
+   local socket, which will be used to send/receive messages.
215 222
 
216 223
    Default value is “NULL”.
217 224
 
... ...
@@ -222,7 +229,22 @@ modparam("dmq", "server_address", "sip:10.0.0.20:5060")
222 229
 modparam("dmq", "server_address", "sip:10.0.0.20:5061;transport=tls")
223 230
 ...
224 231
 
225
-3.2. notification_address(str)
232
+3.2. server_socket(str)
233
+
234
+   The local listen address. This is the interface over which the DMQ
235
+   engine will send/receive messages.
236
+
237
+   Note: if this parameter is not set, the socket to send/receice messages
238
+   is built from server_address parameter.
239
+
240
+   Default value is “NULL”.
241
+
242
+   Example 1.3. Set server_socket parameter
243
+...
244
+modparam("dmq", "server_socket", "udp:10.0.0.20:5060")
245
+...
246
+
247
+3.3. notification_address(str)
226 248
 
227 249
    The address of another DMQ node from which the local node should
228 250
    retrieve initial information about all other nodes. This parameter can
... ...
@@ -232,25 +254,25 @@ modparam("dmq", "server_address", "sip:10.0.0.20:5061;transport=tls")
232 254
 
233 255
    Default value is “NULL”.
234 256
 
235
-   Example 1.3. Set notification_address parameter
257
+   Example 1.4. Set notification_address parameter
236 258
 ...
237 259
 modparam("dmq", "notification_address", "sip:10.0.0.21:5060")
238 260
 ...
239 261
 modparam("dmq", "notification_address", "sip:10.0.0.21:5061;transport=tls")
240 262
 ...
241 263
 
242
-3.3. notification_channel(str)
264
+3.4. notification_channel(str)
243 265
 
244 266
    The name of the channel for notifications about peers availability.
245 267
 
246 268
    Default value is “notification_peer”.
247 269
 
248
-   Example 1.4. Set notification_channel parameter
270
+   Example 1.5. Set notification_channel parameter
249 271
 ...
250 272
 modparam("dmq", "notification_channel", "peers")
251 273
 ...
252 274
 
253
-3.4. multi_notify(int)
275
+3.5. multi_notify(int)
254 276
 
255 277
    Enables the ability to resolve multiple IPv4/IPv6 addresses for a
256 278
    single notification address. Please note that this mode is not
... ...
@@ -262,23 +284,23 @@ modparam("dmq", "notification_channel", "peers")
262 284
 
263 285
    Default value is “0”.
264 286
 
265
-   Example 1.5. Set multi_notify parameter
287
+   Example 1.6. Set multi_notify parameter
266 288
 ...
267 289
 modparam("dmq", "multi_notify", 1)
268 290
 ...
269 291
 
270
-3.5. num_workers(int)
292
+3.6. num_workers(int)
271 293
 
272 294
    The number of worker threads for sending/receiving messages.
273 295
 
274 296
    Default value is “2”.
275 297
 
276
-   Example 1.6. Set num_workers parameter
298
+   Example 1.7. Set num_workers parameter
277 299
 ...
278 300
 modparam("dmq", "num_workers", 4)
279 301
 ...
280 302
 
281
-3.6. worker_usleep(int)
303
+3.7. worker_usleep(int)
282 304
 
283 305
    The default locking/synchronisation mechanism between producer/consumer
284 306
    threads is the optimum for most environments. On some systems (e.g.
... ...
@@ -293,19 +315,19 @@ modparam("dmq", "num_workers", 4)
293 315
 
294 316
    Default value is 0 (recommended for most systems).
295 317
 
296
-   Example 1.7. Set worker_usleep parameter
318
+   Example 1.8. Set worker_usleep parameter
297 319
 ...
298 320
 modparam("dmq", "worker_usleep", 1000)
299 321
 ...
300 322
 
301
-3.7. ping_interval(int)
323
+3.8. ping_interval(int)
302 324
 
303 325
    The number of seconds between node pings (for checking status of other
304 326
    nodes).
305 327
 
306 328
    Minimum value is “60” (default).
307 329
 
308
-   Example 1.8. Set ping_interval parameter
330
+   Example 1.9. Set ping_interval parameter
309 331
 ...
310 332
 modparam("dmq", "ping_interval", 90)
311 333
 ...
... ...
@@ -332,7 +354,7 @@ modparam("dmq", "ping_interval", 90)
332 354
 
333 355
    This function can be used from REQUEST_ROUTE.
334 356
 
335
-   Example 1.9. dmq_handle_message usage
357
+   Example 1.10. dmq_handle_message usage
336 358
 ...
337 359
     if(is_method("KDMQ")) {
338 360
         dmq_handle_message();
... ...
@@ -353,7 +375,7 @@ modparam("dmq", "ping_interval", 90)
353 375
 
354 376
    This function can be used from REQUEST_ROUTE.
355 377
 
356
-   Example 1.10. dmq_process_message usage
378
+   Example 1.11. dmq_process_message usage
357 379
 ...
358 380
     if(is_method("KDMQ")) {
359 381
         dmq_process_message();
... ...
@@ -373,7 +395,7 @@ modparam("dmq", "ping_interval", 90)
373 395
 
374 396
    This function can be used from any route.
375 397
 
376
-   Example 1.11. dmq_send_message usage
398
+   Example 1.12. dmq_send_message usage
377 399
 ...
378 400
         dmq_send_message("channel1", "sip:10.0.0.21:5060", "Message body...", "t
379 401
 ext/plain");
... ...
@@ -391,7 +413,7 @@ ext/plain");
391 413
 
392 414
    This function can be used from any route.
393 415
 
394
-   Example 1.12. dmq_bcast_message usage
416
+   Example 1.13. dmq_bcast_message usage
395 417
 ...
396 418
     dmq_bcast_message("channel1", "Message body...", "text/plain");
397 419
 ...
... ...
@@ -413,7 +435,7 @@ ext/plain");
413 435
 
414 436
    This function can be used from REQUEST_ROUTE only.
415 437
 
416
-   Example 1.13. dmq_t_replicate usage
438
+   Example 1.14. dmq_t_replicate usage
417 439
 ...
418 440
     dmq_t_replicate();
419 441
 ...
... ...
@@ -425,7 +447,7 @@ ext/plain");
425 447
 
426 448
    This function can be used from REQUEST_ROUTE only.
427 449
 
428
-   Example 1.14. dmq_is_from_node usage
450
+   Example 1.15. dmq_is_from_node usage
429 451
 ...
430 452
         # basic example for REGISTER replication
431 453
     if(is_method("REGISTER")) {
... ...
@@ -447,7 +469,7 @@ ext/plain");
447 469
 
448 470
    List the DMQ nodes. It has no parameters.
449 471
 
450
-   Example 1.15. dmq.list_nodes usage
472
+   Example 1.16. dmq.list_nodes usage
451 473
 ...
452 474
 kamcmd dmq.list_nodes
453 475
 ...