Browse code

dmq: regenerate readme

Charles Chance authored on 21/04/2015 21:07:23
Showing 1 changed files
... ...
@@ -18,11 +18,11 @@ Edited by
18 18
 
19 19
 Charles Chance
20 20
 
21
-   Copyright � 2011 Marius Bucur
21
+   Copyright © 2011 Marius Bucur
22 22
 
23
-   Copyright � 2013 Charles Chance, Sipcentric Ltd.
23
+   Copyright © 2013 Charles Chance, Sipcentric Ltd.
24 24
 
25
-   Copyright � 2015 Olle E. Johansson, Edvina AB
25
+   Copyright © 2015 Olle E. Johansson, Edvina AB
26 26
      __________________________________________________________________
27 27
 
28 28
    Table of Contents
... ...
@@ -39,8 +39,9 @@ Charles Chance
39 39
 
40 40
               3.1. server_address(str)
41 41
               3.2. notification_address(str)
42
-              3.3. num_workers(int)
43
-              3.4. ping_interval(int)
42
+              3.3. multi_notify(int)
43
+              3.4. num_workers(int)
44
+              3.5. ping_interval(int)
44 45
 
45 46
         4. Functions
46 47
 
... ...
@@ -67,13 +68,14 @@ Charles Chance
67 68
    1.1. Example of a KDMQ message
68 69
    1.2. Set server_address parameter
69 70
    1.3. Set notification_address parameter
70
-   1.4. Set num_workers parameter
71
-   1.5. Set ping_interval parameter
72
-   1.6. dmq_handle_message usage
73
-   1.7. dmq_send_message usage
74
-   1.8. dmq_bcast_message usage
75
-   1.9. dmq_t_replicate usage
76
-   1.10. dmq_is_from_node usage
71
+   1.4. Set multi_notify parameter
72
+   1.5. Set num_workers parameter
73
+   1.6. Set ping_interval parameter
74
+   1.7. dmq_handle_message usage
75
+   1.8. dmq_send_message usage
76
+   1.9. dmq_bcast_message usage
77
+   1.10. dmq_t_replicate usage
78
+   1.11. dmq_is_from_node usage
77 79
    2.1. dmq_api_t structure
78 80
    2.2. register_dmq_peer usage
79 81
    2.3. bcast_message usage
... ...
@@ -93,8 +95,9 @@ Chapter 1. Admin Guide
93 95
 
94 96
         3.1. server_address(str)
95 97
         3.2. notification_address(str)
96
-        3.3. num_workers(int)
97
-        3.4. ping_interval(int)
98
+        3.3. multi_notify(int)
99
+        3.4. num_workers(int)
100
+        3.5. ping_interval(int)
98 101
 
99 102
    4. Functions
100 103
 
... ...
@@ -164,15 +167,16 @@ sip:192.168.40.17:5060;status=active
164 167
 
165 168
    3.1. server_address(str)
166 169
    3.2. notification_address(str)
167
-   3.3. num_workers(int)
168
-   3.4. ping_interval(int)
170
+   3.3. multi_notify(int)
171
+   3.4. num_workers(int)
172
+   3.5. ping_interval(int)
169 173
 
170 174
 3.1. server_address(str)
171 175
 
172 176
    The local server address. This is the interface over which the DMQ
173 177
    engine will send/receive messages.
174 178
 
175
-   Default value is "NULL".
179
+   Default value is “NULL”.
176 180
 
177 181
    Example 1.2. Set server_address parameter
178 182
 ...
... ...
@@ -184,32 +188,48 @@ modparam("dmq", "server_address", "sip:10.0.0.20:5060")
184 188
    The address of another DMQ node from which the local node should
185 189
    retrieve initial information about all other nodes.
186 190
 
187
-   Default value is "NULL".
191
+   Default value is “NULL”.
188 192
 
189 193
    Example 1.3. Set notification_address parameter
190 194
 ...
191 195
 modparam("dmq", "notification_address", "sip:10.0.0.21:5060")
192 196
 ...
193 197
 
194
-3.3. num_workers(int)
198
+3.3. multi_notify(int)
199
+
200
+   Enables the ability to resolve multiple IPv4/IPv6 addresses for a
201
+   single notification address.
202
+
203
+   A value of zero resolves to the first IP address found. A non-zero
204
+   value resolves to all IP addresses associated with the host. This
205
+   includes addresses from DNS SRV records, A and AAAA records.
206
+
207
+   Default value is “0”.
208
+
209
+   Example 1.4. Set multi_notify parameter
210
+...
211
+modparam("dmq", "multi_notify", 1)
212
+...
213
+
214
+3.4. num_workers(int)
195 215
 
196 216
    The number of worker threads for sending/receiving messages.
197 217
 
198
-   Default value is "2".
218
+   Default value is “2”.
199 219
 
200
-   Example 1.4. Set num_workers parameter
220
+   Example 1.5. Set num_workers parameter
201 221
 ...
202 222
 modparam("dmq", "num_threads", 4)
203 223
 ...
204 224
 
205
-3.4. ping_interval(int)
225
+3.5. ping_interval(int)
206 226
 
207 227
    The number of seconds between node pings (for checking status of other
208 228
    nodes).
209 229
 
210
-   Minimum value is "60" (default).
230
+   Minimum value is “60” (default).
211 231
 
212
-   Example 1.5. Set ping_interval parameter
232
+   Example 1.6. Set ping_interval parameter
213 233
 ...
214 234
 modparam("dmq", "ping_interval", 90)
215 235
 ...
... ...
@@ -222,14 +242,14 @@ modparam("dmq", "ping_interval", 90)
222 242
    4.4. dmq_t_replicate([skip_loop_test])
223 243
    4.5. dmq_is_from_node()
224 244
 
225
-4.1. dmq_handle_message()
245
+4.1.  dmq_handle_message()
226 246
 
227 247
    Handles a DMQ message by passing it to the appropriate local peer
228 248
    (module). The peer is identified by the user part of the To header.
229 249
 
230 250
    This function can be used from REQUEST_ROUTE.
231 251
 
232
-   Example 1.6. dmq_handle_message usage
252
+   Example 1.7. dmq_handle_message usage
233 253
 ...
234 254
         if(is_method("KDMQ"))
235 255
         {
... ...
@@ -237,7 +257,7 @@ modparam("dmq", "ping_interval", 90)
237 257
         }
238 258
 ...
239 259
 
240
-4.2. dmq_send_message(peer, node, body, content_type)
260
+4.2.  dmq_send_message(peer, node, body, content_type)
241 261
 
242 262
    Sends a DMQ message directly from config file to a single node.
243 263
 
... ...
@@ -249,13 +269,13 @@ modparam("dmq", "ping_interval", 90)
249 269
 
250 270
    This function can be used from any route.
251 271
 
252
-   Example 1.7. dmq_send_message usage
272
+   Example 1.8. dmq_send_message usage
253 273
 ...
254 274
         dmq_send_message("peer_name", "sip:10.0.0.21:5060", "Message body...", "
255 275
 text/plain");
256 276
 ...
257 277
 
258
-4.3. dmq_bcast_message(peer, body, content_type)
278
+4.3.  dmq_bcast_message(peer, body, content_type)
259 279
 
260 280
    Broadcasts a DMQ message from config file to all active nodes (except
261 281
    self).
... ...
@@ -267,12 +287,12 @@ text/plain");
267 287
 
268 288
    This function can be used from any route.
269 289
 
270
-   Example 1.8. dmq_bcast_message usage
290
+   Example 1.9. dmq_bcast_message usage
271 291
 ...
272 292
         dmq_bcast_message("peer_name", "Message body...", "text/plain");
273 293
 ...
274 294
 
275
-4.4. dmq_t_replicate([skip_loop_test])
295
+4.4.  dmq_t_replicate([skip_loop_test])
276 296
 
277 297
    Replicates the current SIP message to all active nodes (except self).
278 298
    Useful for replicating REGISTER, PUBLISH etc. in a clustered
... ...
@@ -289,19 +309,19 @@ text/plain");
289 309
 
290 310
    This function can be used from REQUEST_ROUTE only.
291 311
 
292
-   Example 1.9. dmq_t_replicate usage
312
+   Example 1.10. dmq_t_replicate usage
293 313
 ...
294 314
         dmq_t_replicate();
295 315
 ...
296 316
 
297
-4.5. dmq_is_from_node()
317
+4.5.  dmq_is_from_node()
298 318
 
299 319
    Checks whether the current message has been sent by another DMQ node in
300 320
    the cluster.
301 321
 
302 322
    This function can be used from REQUEST_ROUTE only.
303 323
 
304
-   Example 1.10. dmq_is_from_node usage
324
+   Example 1.11. dmq_is_from_node usage
305 325
 ...
306 326
         # Example REGISTER block
307 327
         if (dmq_is_from_node()) {
... ...
@@ -331,7 +351,7 @@ Chapter 2. Developer Guide
331 351
    The module provides the following functions that can be used in other
332 352
    Kamailio modules.
333 353
 
334
-1. dmq_load_api(dmq_api_t* api)
354
+1.  dmq_load_api(dmq_api_t* api)
335 355
 
336 356
    This function binds the DMQ module and fills the structure with the
337 357
    exported functions below.
... ...
@@ -345,7 +365,7 @@ typedef struct dmq_api {
345 365
 } dmq_api_t;
346 366
 ...
347 367
 
348
-2. register_dmq_peer(dmq_peer_t* peer)
368
+2.  register_dmq_peer(dmq_peer_t* peer)
349 369
 
350 370
    Registers an entity as a DMQ peer which permits receiving/sending
351 371
    messages between nodes which support the same peer.
... ...
@@ -355,7 +375,7 @@ typedef struct dmq_api {
355 375
         Example to follow.
356 376
 ...
357 377
 
358
-3. bcast_message(dmq_peer_t* peer, str* body, dmq_node_t* except,
378
+3.  bcast_message(dmq_peer_t* peer, str* body, dmq_node_t* except,
359 379
 dmq_resp_cback_t* resp_cback, int max_forwards, str* content_type)
360 380
 
361 381
    Broadcast a DMQ message to all nodes in the DMQ bus excluding self,
... ...
@@ -366,7 +386,7 @@ dmq_resp_cback_t* resp_cback, int max_forwards, str* content_type)
366 386
         Example to follow.
367 387
 ...
368 388
 
369
-4. send_message(dmq_peer_t* peer, str* body, dmq_node_t* node,
389
+4.  send_message(dmq_peer_t* peer, str* body, dmq_node_t* node,
370 390
 dmq_resp_cback_t* resp_cback, int max_forwards, str* content_type)
371 391
 
372 392
    Send a DMQ message to a single node.