Browse code

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

Kamailio Dev authored on 23/07/2020 14:01:15
Showing 1 changed files
... ...
@@ -35,6 +35,10 @@ Daniel-Constantin Mierla
35 35
               3.8. event_callback (str)
36 36
               3.9. event_mode (int)
37 37
               3.10. contact_host (str)
38
+              3.11. contact_mode (int)
39
+              3.12. cparam_name (int)
40
+              3.13. a_contact_avp (str)
41
+              3.14. b_contact_avp (str)
38 42
 
39 43
         4. Event Routes
40 44
 
... ...
@@ -53,8 +57,12 @@ Daniel-Constantin Mierla
53 57
    1.8. Set event_callback parameter
54 58
    1.9. Set event_mode parameter
55 59
    1.10. Set contact_host parameter
56
-   1.11. Usage of event_route[topos:msg-outgoing]
57
-   1.12. Usage of event_route[topos:msg-sending]
60
+   1.11. Set contact_mode parameter
61
+   1.12. Set cparam_name parameter
62
+   1.13. Set a_contact_avp parameter
63
+   1.14. Set b_contact_avp parameter
64
+   1.15. Usage of event_route[topos:msg-outgoing]
65
+   1.16. Usage of event_route[topos:msg-sending]
58 66
 
59 67
 Chapter 1. Admin Guide
60 68
 
... ...
@@ -78,6 +86,10 @@ Chapter 1. Admin Guide
78 86
         3.8. event_callback (str)
79 87
         3.9. event_mode (int)
80 88
         3.10. contact_host (str)
89
+        3.11. contact_mode (int)
90
+        3.12. cparam_name (int)
91
+        3.13. a_contact_avp (str)
92
+        3.14. b_contact_avp (str)
81 93
 
82 94
    4. Event Routes
83 95
 
... ...
@@ -130,6 +142,10 @@ Chapter 1. Admin Guide
130 142
    3.8. event_callback (str)
131 143
    3.9. event_mode (int)
132 144
    3.10. contact_host (str)
145
+   3.11. contact_mode (int)
146
+   3.12. cparam_name (int)
147
+   3.13. a_contact_avp (str)
148
+   3.14. b_contact_avp (str)
133 149
 
134 150
 3.1. storage (str)
135 151
 
... ...
@@ -270,6 +286,72 @@ modparam("topos", "event_mode", 2)
270 286
 modparam("topos", "contact_host", "proxy.domain.com")
271 287
 ...
272 288
 
289
+3.11. contact_mode (int)
290
+
291
+   Control the mode where the key to lookup the message data from the
292
+   database or redis server is stored. The default is to use the Contact
293
+   user (0), alternatively a Contact URI parameter can be used (1) with
294
+   values from the SIP message, or from AVP variables (2). This can be
295
+   useful for interoperating which gateways that need a certain user part
296
+   in the Contact URI.
297
+
298
+   In mode (1) the a-side contact user is taken from the request URI and
299
+   the b-side contact user from the Contact header of the processed
300
+   initial SIP request.
301
+
302
+   If you use the mode (2), you need to configure the a_contact_avp and
303
+   b_contact_avp parameter. Furthermore you need to assign values to them
304
+   during the processing of the initial SIP request.
305
+
306
+   The name of the Contact URI parameter can be customized with the
307
+   cparam_name parameter.
308
+
309
+   Default value is 0 - use the Contact user
310
+
311
+   Example 1.11. Set contact_mode parameter
312
+...
313
+modparam("topos", "contact_mode", 1)
314
+...
315
+
316
+3.12. cparam_name (int)
317
+
318
+   Name of the Contact URI parameter to store the database or redis server
319
+   key for message lookup.
320
+
321
+   This parameter is only used when the contact_mode parameter is set to 1
322
+   or 2.
323
+
324
+   Default value is “tps”.
325
+
326
+   Example 1.12. Set cparam_name parameter
327
+...
328
+modparam("topos", "cparam_name", "xyz")
329
+...
330
+
331
+3.13. a_contact_avp (str)
332
+
333
+   Name of the AVP parameter to evaluate for the A-side Contact Header
334
+   user part. This parameter is only necessary in contact_mode (2).
335
+
336
+   Default value is “NULL” (disabled).
337
+
338
+   Example 1.13. Set a_contact_avp parameter
339
+...
340
+modparam("topos", "a_contact_avp", "$avp(tps-act)")
341
+...
342
+
343
+3.14. b_contact_avp (str)
344
+
345
+   Name of the AVP parameter to evaluate for the B-side Contact Header
346
+   user part. This parameter is only necessary in contact_mode (2).
347
+
348
+   Default value is “NULL” (disabled).
349
+
350
+   Example 1.14. Set b_contact_avp parameter
351
+...
352
+modparam("topos", "b_contact_avp", "$avp(tps-bct)")
353
+...
354
+
273 355
 4. Event Routes
274 356
 
275 357
    4.1. event_route[topos:msg-outgoing]
... ...
@@ -287,7 +369,7 @@ modparam("topos", "contact_host", "proxy.domain.com")
287 369
    reparsing the outgoing SIP message for the cases when topology hiding
288 370
    is not wanted.
289 371
 
290
-   Example 1.11. Usage of event_route[topos:msg-outgoing]
372
+   Example 1.15. Usage of event_route[topos:msg-outgoing]
291 373
 ...
292 374
 event_route[topos:msg-outgoing] {
293 375
   if($sndto(ip)=="10.1.1.10") {
... ...
@@ -306,7 +388,7 @@ event_route[topos:msg-outgoing] {
306 388
    $sndto(proto) point to the destination. The SIP message is the one to
307 389
    be sent out.
308 390
 
309
-   Example 1.12. Usage of event_route[topos:msg-sending]
391
+   Example 1.16. Usage of event_route[topos:msg-sending]
310 392
 ...
311 393
 event_route[topos:msg-sending] {
312 394
   if(is_request() and $fU=="alice") {