Browse code

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

Kamailio Dev authored on 21/08/2022 13:46:09
Showing 1 changed files
... ...
@@ -500,11 +500,11 @@ modparam("topos", "methods_nocontact", "CANCEL,PRACK")
500 500
 
501 501
    List of headers to disable multiple comma separated values inserted in
502 502
    compact form. Altough compact form is RFC compliant this paramter gives
503
-   possibilty to disable compact form header values for UA that dont
504
-   support/handle it. The following options are available: (1) - disable
505
-   multiple comma separated values for Via header (2) - disable multiple
506
-   comma separated values for Record-Route header (4) - disable multiple
507
-   comma separated values for Route header
503
+   possibilty to disable compact form header values for UA that don't
504
+   support or can't handle it. The following options are available: (1) -
505
+   disable multiple comma separated values for Via header (2) - disable
506
+   multiple comma separated values for Record-Route header (4) - disable
507
+   multiple comma separated values for Route header
508 508
 
509 509
    Default value is “0”.
510 510
 
Browse code

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

Kamailio Dev authored on 21/08/2022 13:31:12
Showing 1 changed files
... ...
@@ -50,7 +50,8 @@ Frederic Gaisnon
50 50
               3.17. rr_update (int)
51 51
               3.18. context (str)
52 52
               3.19. methods_nocontact (str)
53
-              3.20. methods_noinitial (str)
53
+              3.20. header_mode (int)
54
+              3.21. methods_noinitial (str)
54 55
 
55 56
         4. Functions
56 57
 
... ...
@@ -84,12 +85,13 @@ Frederic Gaisnon
84 85
    1.17. Set rr_update parameter
85 86
    1.18. Set context parameter
86 87
    1.19. Set methods_nocontact parameter
87
-   1.20. Set methods_noinitial parameter
88
-   1.21. tps_set_context usage
89
-   1.22. Usage of event_route[topos:msg-outgoing]
90
-   1.23. Usage of event_route[topos:msg-sending]
91
-   1.24. Usage of event_route[topos:msg-incoming]
92
-   1.25. Usage of event_route[topos:msg-receoving]
88
+   1.20. Set header_mode parameter
89
+   1.21. Set methods_noinitial parameter
90
+   1.22. tps_set_context usage
91
+   1.23. Usage of event_route[topos:msg-outgoing]
92
+   1.24. Usage of event_route[topos:msg-sending]
93
+   1.25. Usage of event_route[topos:msg-incoming]
94
+   1.26. Usage of event_route[topos:msg-receoving]
93 95
 
94 96
 Chapter 1. Admin Guide
95 97
 
... ...
@@ -122,7 +124,8 @@ Chapter 1. Admin Guide
122 124
         3.17. rr_update (int)
123 125
         3.18. context (str)
124 126
         3.19. methods_nocontact (str)
125
-        3.20. methods_noinitial (str)
127
+        3.20. header_mode (int)
128
+        3.21. methods_noinitial (str)
126 129
 
127 130
    4. Functions
128 131
 
... ...
@@ -196,7 +199,8 @@ Chapter 1. Admin Guide
196 199
    3.17. rr_update (int)
197 200
    3.18. context (str)
198 201
    3.19. methods_nocontact (str)
199
-   3.20. methods_noinitial (str)
202
+   3.20. header_mode (int)
203
+   3.21. methods_noinitial (str)
200 204
 
201 205
 3.1. storage (str)
202 206
 
... ...
@@ -492,14 +496,31 @@ modparam("topos", "context", "srvone")
492 496
 modparam("topos", "methods_nocontact", "CANCEL,PRACK")
493 497
 ...
494 498
 
495
-3.20. methods_noinitial (str)
499
+3.20. header_mode (int)
500
+
501
+   List of headers to disable multiple comma separated values inserted in
502
+   compact form. Altough compact form is RFC compliant this paramter gives
503
+   possibilty to disable compact form header values for UA that dont
504
+   support/handle it. The following options are available: (1) - disable
505
+   multiple comma separated values for Via header (2) - disable multiple
506
+   comma separated values for Record-Route header (4) - disable multiple
507
+   comma separated values for Route header
508
+
509
+   Default value is “0”.
510
+
511
+   Example 1.20. Set header_mode parameter
512
+...
513
+modparam("topos", "header_mode", 1)
514
+...
515
+
516
+3.21. methods_noinitial (str)
496 517
 
497 518
    List of SIP methods to skip doing topos if it is an intial request (no
498 519
    To-tag).
499 520
 
500 521
    Default value is “” (no method).
501 522
 
502
-   Example 1.20. Set methods_noinitial parameter
523
+   Example 1.21. Set methods_noinitial parameter
503 524
 ...
504 525
 modparam("topos", "methods_noinitial", "OPTIONS,NOTIFY")
505 526
 ...
... ...
@@ -515,7 +536,7 @@ modparam("topos", "methods_noinitial", "OPTIONS,NOTIFY")
515 536
 
516 537
    This function can be used from ANY_ROUTE.
517 538
 
518
-   Example 1.21. tps_set_context usage
539
+   Example 1.22. tps_set_context usage
519 540
 ...
520 541
 request_route {
521 542
     ...
... ...
@@ -543,7 +564,7 @@ request_route {
543 564
    reparsing the outgoing SIP message for the cases when topology hiding
544 565
    is not wanted.
545 566
 
546
-   Example 1.22. Usage of event_route[topos:msg-outgoing]
567
+   Example 1.23. Usage of event_route[topos:msg-outgoing]
547 568
 ...
548 569
 event_route[topos:msg-outgoing] {
549 570
   if($sndto(ip)=="10.1.1.10") {
... ...
@@ -562,7 +583,7 @@ event_route[topos:msg-outgoing] {
562 583
    $sndto(proto) point to the destination. The SIP message is the one to
563 584
    be sent out.
564 585
 
565
-   Example 1.23. Usage of event_route[topos:msg-sending]
586
+   Example 1.24. Usage of event_route[topos:msg-sending]
566 587
 ...
567 588
 event_route[topos:msg-sending] {
568 589
   if(is_request() and $fU=="alice") {
... ...
@@ -582,7 +603,7 @@ event_route[topos:msg-sending] {
582 603
    internally generated one at startup, to avoid reparsing the outgoing
583 604
    SIP message for the cases when topology hiding is not wanted.
584 605
 
585
-   Example 1.24. Usage of event_route[topos:msg-incoming]
606
+   Example 1.25. Usage of event_route[topos:msg-incoming]
586 607
 ...
587 608
 event_route[topos:msg-incoming] {
588 609
   if($si=="10.1.1.10") {
... ...
@@ -600,7 +621,7 @@ event_route[topos:msg-incoming] {
600 621
    Inside the event route the variables $si, $sp and $proto point to the
601 622
    source address. The SIP message is the one to be sent out.
602 623
 
603
-   Example 1.25. Usage of event_route[topos:msg-receoving]
624
+   Example 1.26. Usage of event_route[topos:msg-receoving]
604 625
 ...
605 626
 event_route[topos:msg-receiving] {
606 627
   if(is_request() and $fU=="alice") {
Browse code

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

Kamailio Dev authored on 05/07/2022 18:46:19
Showing 1 changed files
... ...
@@ -50,6 +50,7 @@ Frederic Gaisnon
50 50
               3.17. rr_update (int)
51 51
               3.18. context (str)
52 52
               3.19. methods_nocontact (str)
53
+              3.20. methods_noinitial (str)
53 54
 
54 55
         4. Functions
55 56
 
... ...
@@ -83,11 +84,12 @@ Frederic Gaisnon
83 84
    1.17. Set rr_update parameter
84 85
    1.18. Set context parameter
85 86
    1.19. Set methods_nocontact parameter
86
-   1.20. tps_set_context usage
87
-   1.21. Usage of event_route[topos:msg-outgoing]
88
-   1.22. Usage of event_route[topos:msg-sending]
89
-   1.23. Usage of event_route[topos:msg-incoming]
90
-   1.24. Usage of event_route[topos:msg-receoving]
87
+   1.20. Set methods_noinitial parameter
88
+   1.21. tps_set_context usage
89
+   1.22. Usage of event_route[topos:msg-outgoing]
90
+   1.23. Usage of event_route[topos:msg-sending]
91
+   1.24. Usage of event_route[topos:msg-incoming]
92
+   1.25. Usage of event_route[topos:msg-receoving]
91 93
 
92 94
 Chapter 1. Admin Guide
93 95
 
... ...
@@ -120,6 +122,7 @@ Chapter 1. Admin Guide
120 122
         3.17. rr_update (int)
121 123
         3.18. context (str)
122 124
         3.19. methods_nocontact (str)
125
+        3.20. methods_noinitial (str)
123 126
 
124 127
    4. Functions
125 128
 
... ...
@@ -193,6 +196,7 @@ Chapter 1. Admin Guide
193 196
    3.17. rr_update (int)
194 197
    3.18. context (str)
195 198
    3.19. methods_nocontact (str)
199
+   3.20. methods_noinitial (str)
196 200
 
197 201
 3.1. storage (str)
198 202
 
... ...
@@ -488,6 +492,18 @@ modparam("topos", "context", "srvone")
488 492
 modparam("topos", "methods_nocontact", "CANCEL,PRACK")
489 493
 ...
490 494
 
495
+3.20. methods_noinitial (str)
496
+
497
+   List of SIP methods to skip doing topos if it is an intial request (no
498
+   To-tag).
499
+
500
+   Default value is “” (no method).
501
+
502
+   Example 1.20. Set methods_noinitial parameter
503
+...
504
+modparam("topos", "methods_noinitial", "OPTIONS,NOTIFY")
505
+...
506
+
491 507
 4. Functions
492 508
 
493 509
    4.1. tps_set_context(ctx)
... ...
@@ -499,7 +515,7 @@ modparam("topos", "methods_nocontact", "CANCEL,PRACK")
499 515
 
500 516
    This function can be used from ANY_ROUTE.
501 517
 
502
-   Example 1.20. tps_set_context usage
518
+   Example 1.21. tps_set_context usage
503 519
 ...
504 520
 request_route {
505 521
     ...
... ...
@@ -527,7 +543,7 @@ request_route {
527 543
    reparsing the outgoing SIP message for the cases when topology hiding
528 544
    is not wanted.
529 545
 
530
-   Example 1.21. Usage of event_route[topos:msg-outgoing]
546
+   Example 1.22. Usage of event_route[topos:msg-outgoing]
531 547
 ...
532 548
 event_route[topos:msg-outgoing] {
533 549
   if($sndto(ip)=="10.1.1.10") {
... ...
@@ -546,7 +562,7 @@ event_route[topos:msg-outgoing] {
546 562
    $sndto(proto) point to the destination. The SIP message is the one to
547 563
    be sent out.
548 564
 
549
-   Example 1.22. Usage of event_route[topos:msg-sending]
565
+   Example 1.23. Usage of event_route[topos:msg-sending]
550 566
 ...
551 567
 event_route[topos:msg-sending] {
552 568
   if(is_request() and $fU=="alice") {
... ...
@@ -566,7 +582,7 @@ event_route[topos:msg-sending] {
566 582
    internally generated one at startup, to avoid reparsing the outgoing
567 583
    SIP message for the cases when topology hiding is not wanted.
568 584
 
569
-   Example 1.23. Usage of event_route[topos:msg-incoming]
585
+   Example 1.24. Usage of event_route[topos:msg-incoming]
570 586
 ...
571 587
 event_route[topos:msg-incoming] {
572 588
   if($si=="10.1.1.10") {
... ...
@@ -584,7 +600,7 @@ event_route[topos:msg-incoming] {
584 600
    Inside the event route the variables $si, $sp and $proto point to the
585 601
    source address. The SIP message is the one to be sent out.
586 602
 
587
-   Example 1.24. Usage of event_route[topos:msg-receoving]
603
+   Example 1.25. Usage of event_route[topos:msg-receoving]
588 604
 ...
589 605
 event_route[topos:msg-receiving] {
590 606
   if(is_request() and $fU=="alice") {
Browse code

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

Kamailio Dev authored on 04/07/2022 13:46:14
Showing 1 changed files
... ...
@@ -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
Browse code

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

Kamailio Dev authored on 21/06/2022 07:01:17
Showing 1 changed files
... ...
@@ -49,6 +49,7 @@ Frederic Gaisnon
49 49
               3.16. xavu_field_contact_host (str)
50 50
               3.17. rr_update (int)
51 51
               3.18. context (str)
52
+              3.19. methods_nocontact (str)
52 53
 
53 54
         4. Functions
54 55
 
... ...
@@ -81,11 +82,12 @@ Frederic Gaisnon
81 82
    1.16. Set xavu_field_contact_host parameter
82 83
    1.17. Set rr_update parameter
83 84
    1.18. Set context parameter
84
-   1.19. tps_set_context usage
85
-   1.20. Usage of event_route[topos:msg-outgoing]
86
-   1.21. Usage of event_route[topos:msg-sending]
87
-   1.22. Usage of event_route[topos:msg-incoming]
88
-   1.23. Usage of event_route[topos:msg-receoving]
85
+   1.19. Set methods_nocontact parameter
86
+   1.20. tps_set_context usage
87
+   1.21. Usage of event_route[topos:msg-outgoing]
88
+   1.22. Usage of event_route[topos:msg-sending]
89
+   1.23. Usage of event_route[topos:msg-incoming]
90
+   1.24. Usage of event_route[topos:msg-receoving]
89 91
 
90 92
 Chapter 1. Admin Guide
91 93
 
... ...
@@ -117,6 +119,7 @@ Chapter 1. Admin Guide
117 119
         3.16. xavu_field_contact_host (str)
118 120
         3.17. rr_update (int)
119 121
         3.18. context (str)
122
+        3.19. methods_nocontact (str)
120 123
 
121 124
    4. Functions
122 125
 
... ...
@@ -187,6 +190,7 @@ Chapter 1. Admin Guide
187 190
    3.16. xavu_field_contact_host (str)
188 191
    3.17. rr_update (int)
189 192
    3.18. context (str)
193
+   3.19. methods_nocontact (str)
190 194
 
191 195
 3.1. storage (str)
192 196
 
... ...
@@ -471,6 +475,17 @@ modparam("topos", "rr_update", 1)
471 475
 modparam("topos", "context", "srvone")
472 476
 ...
473 477
 
478
+3.19. methods_nocontact (str)
479
+
480
+   List of SIP methods to skip adding Contact header for.
481
+
482
+   Default value is “BYE,CANCEL,PRACK”.
483
+
484
+   Example 1.19. Set methods_nocontact parameter
485
+...
486
+modparam("topos", "methods_nocontact", "CANCEL,PRACK")
487
+...
488
+
474 489
 4. Functions
475 490
 
476 491
    4.1. tps_set_context(ctx)
... ...
@@ -482,7 +497,7 @@ modparam("topos", "context", "srvone")
482 497
 
483 498
    This function can be used from ANY_ROUTE.
484 499
 
485
-   Example 1.19. tps_set_context usage
500
+   Example 1.20. tps_set_context usage
486 501
 ...
487 502
 request_route {
488 503
     ...
... ...
@@ -510,7 +525,7 @@ request_route {
510 525
    reparsing the outgoing SIP message for the cases when topology hiding
511 526
    is not wanted.
512 527
 
513
-   Example 1.20. Usage of event_route[topos:msg-outgoing]
528
+   Example 1.21. Usage of event_route[topos:msg-outgoing]
514 529
 ...
515 530
 event_route[topos:msg-outgoing] {
516 531
   if($sndto(ip)=="10.1.1.10") {
... ...
@@ -529,7 +544,7 @@ event_route[topos:msg-outgoing] {
529 544
    $sndto(proto) point to the destination. The SIP message is the one to
530 545
    be sent out.
531 546
 
532
-   Example 1.21. Usage of event_route[topos:msg-sending]
547
+   Example 1.22. Usage of event_route[topos:msg-sending]
533 548
 ...
534 549
 event_route[topos:msg-sending] {
535 550
   if(is_request() and $fU=="alice") {
... ...
@@ -549,7 +564,7 @@ event_route[topos:msg-sending] {
549 564
    internally generated one at startup, to avoid reparsing the outgoing
550 565
    SIP message for the cases when topology hiding is not wanted.
551 566
 
552
-   Example 1.22. Usage of event_route[topos:msg-incoming]
567
+   Example 1.23. Usage of event_route[topos:msg-incoming]
553 568
 ...
554 569
 event_route[topos:msg-incoming] {
555 570
   if($si=="10.1.1.10") {
... ...
@@ -567,7 +582,7 @@ event_route[topos:msg-incoming] {
567 582
    Inside the event route the variables $si, $sp and $proto point to the
568 583
    source address. The SIP message is the one to be sent out.
569 584
 
570
-   Example 1.23. Usage of event_route[topos:msg-receoving]
585
+   Example 1.24. Usage of event_route[topos:msg-receoving]
571 586
 ...
572 587
 event_route[topos:msg-receiving] {
573 588
   if(is_request() and $fU=="alice") {
Browse code

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

Kamailio Dev authored on 04/10/2021 15:46:22
Showing 1 changed files
... ...
@@ -44,8 +44,8 @@ Frederic Gaisnon
44 44
               3.11. contact_mode (int)
45 45
               3.12. cparam_name (int)
46 46
               3.13. xavu_cfg (str)
47
-              3.14. xavu_filed_a_contact (str)
48
-              3.15. xavu_filed_b_contact (str)
47
+              3.14. xavu_field_a_contact (str)
48
+              3.15. xavu_field_b_contact (str)
49 49
               3.16. xavu_field_contact_host (str)
50 50
               3.17. rr_update (int)
51 51
               3.18. context (str)
... ...
@@ -76,8 +76,8 @@ Frederic Gaisnon
76 76
    1.11. Set contact_mode parameter
77 77
    1.12. Set cparam_name parameter
78 78
    1.13. Set xavu_cfg parameter
79
-   1.14. Set xavu_filed_a_contact parameter
80
-   1.15. Set xavu_filed_b_contact parameter
79
+   1.14. Set xavu_field_a_contact parameter
80
+   1.15. Set xavu_field_b_contact parameter
81 81
    1.16. Set xavu_field_contact_host parameter
82 82
    1.17. Set rr_update parameter
83 83
    1.18. Set context parameter
... ...
@@ -112,8 +112,8 @@ Chapter 1. Admin Guide
112 112
         3.11. contact_mode (int)
113 113
         3.12. cparam_name (int)
114 114
         3.13. xavu_cfg (str)
115
-        3.14. xavu_filed_a_contact (str)
116
-        3.15. xavu_filed_b_contact (str)
115
+        3.14. xavu_field_a_contact (str)
116
+        3.15. xavu_field_b_contact (str)
117 117
         3.16. xavu_field_contact_host (str)
118 118
         3.17. rr_update (int)
119 119
         3.18. context (str)
... ...
@@ -182,8 +182,8 @@ Chapter 1. Admin Guide
182 182
    3.11. contact_mode (int)
183 183
    3.12. cparam_name (int)
184 184
    3.13. xavu_cfg (str)
185
-   3.14. xavu_filed_a_contact (str)
186
-   3.15. xavu_filed_b_contact (str)
185
+   3.14. xavu_field_a_contact (str)
186
+   3.15. xavu_field_b_contact (str)
187 187
    3.16. xavu_field_contact_host (str)
188 188
    3.17. rr_update (int)
189 189
    3.18. context (str)
... ...
@@ -320,7 +320,7 @@ modparam("topos", "event_mode", 2)
320 320
 3.10. contact_host (str)
321 321
 
322 322
    You may need to control the host part of the Contact header added by
323
-   topos. If the xavu_filed_contact_host parameter is set, this value is
323
+   topos. If the xavu_field_contact_host parameter is set, this value is
324 324
    ignored. For example when using TLS with TOPOS the remote UAS must be
325 325
    able to open a new TLS socket to the contact header. In this case, the
326 326
    contact header must contain a domain name with a trusted CA signed
... ...
@@ -388,12 +388,12 @@ modparam("topos", "cparam_name", "xyz")
388 388
    Example 1.13. Set xavu_cfg parameter
389 389
 ...
390 390
 modparam("topos", "xavu_cfg", "_tps_")
391
-modparam("topos", "xavu_filed_a_contact", "a_contact")
391
+modparam("topos", "xavu_field_a_contact", "a_contact")
392 392
 ...
393 393
     $xavu(_tps_=>a_contact) = "...";
394 394
 ...
395 395
 
396
-3.14. xavu_filed_a_contact (str)
396
+3.14. xavu_field_a_contact (str)
397 397
 
398 398
    Name of the field inside root XAVU specifed by `xavu_cfg` to evaluate
399 399
    for the A-side Contact Header user part. This parameter is only
... ...
@@ -401,15 +401,15 @@ modparam("topos", "xavu_filed_a_contact", "a_contact")
401 401
 
402 402
    Default value is “NULL” (disabled).
403 403
 
404
-   Example 1.14. Set xavu_filed_a_contact parameter
404
+   Example 1.14. Set xavu_field_a_contact parameter
405 405
 ...
406 406
 modparam("topos", "xavu_cfg", "_tps_")
407
-modparam("topos", "xavu_filed_a_contact", "a_contact")
407
+modparam("topos", "xavu_field_a_contact", "a_contact")
408 408
 ...
409 409
     $xavu(_tps_=>a_contact) = "...";
410 410
 ...
411 411
 
412
-3.15. xavu_filed_b_contact (str)
412
+3.15. xavu_field_b_contact (str)
413 413
 
414 414
    Name of the field inside root XAVU specifed by `xavu_cfg` to evaluate
415 415
    for the B-side Contact Header user part. This parameter is only
... ...
@@ -417,10 +417,10 @@ modparam("topos", "xavu_filed_a_contact", "a_contact")
417 417
 
418 418
    Default value is “NULL” (disabled).
419 419
 
420
-   Example 1.15. Set xavu_filed_b_contact parameter
420
+   Example 1.15. Set xavu_field_b_contact parameter
421 421
 ...
422 422
 modparam("topos", "xavu_cfg", "_tps_")
423
-modparam("topos", "xavu_filed_b_contact", "b_contact")
423
+modparam("topos", "xavu_field_b_contact", "b_contact")
424 424
 ...
425 425
     $xavu(_tps_=>b_contact) = "...";
426 426
 
Browse code

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

Kamailio Dev authored on 15/06/2021 10:01:24
Showing 1 changed files
... ...
@@ -441,7 +441,7 @@ modparam("topos", "xavu_filed_b_contact", "b_contact")
441 441
    Example 1.16. Set xavu_field_contact_host parameter
442 442
 ...
443 443
 modparam("topos", "xavu_cfg", "_tps_")
444
-modparam("topos", "xavu_contact_host", "contact_host")
444
+modparam("topos", "xavu_field_contact_host", "contact_host")
445 445
 ...
446 446
     $xavu(_tps_=>contact_host) = "kamailio.org";
447 447
 ...
Browse code

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

Kamailio Dev authored on 02/04/2021 08:16:13
Showing 1 changed files
... ...
@@ -46,8 +46,8 @@ Frederic Gaisnon
46 46
               3.13. xavu_cfg (str)
47 47
               3.14. xavu_filed_a_contact (str)
48 48
               3.15. xavu_filed_b_contact (str)
49
-              3.16. rr_update (int)
50
-              3.17. xavu_field_contact_host (str)
49
+              3.16. xavu_field_contact_host (str)
50
+              3.17. rr_update (int)
51 51
               3.18. context (str)
52 52
 
53 53
         4. Functions
... ...
@@ -75,11 +75,11 @@ Frederic Gaisnon
75 75
    1.10. Set contact_host parameter
76 76
    1.11. Set contact_mode parameter
77 77
    1.12. Set cparam_name parameter
78
-   1.13. Set xavu_filed_a_contact parameter
78
+   1.13. Set xavu_cfg parameter
79 79
    1.14. Set xavu_filed_a_contact parameter
80 80
    1.15. Set xavu_filed_b_contact parameter
81
-   1.16. Set rr_update parameter
82
-   1.17. Set xavu_field_contact_host parameter
81
+   1.16. Set xavu_field_contact_host parameter
82
+   1.17. Set rr_update parameter
83 83
    1.18. Set context parameter
84 84
    1.19. tps_set_context usage
85 85
    1.20. Usage of event_route[topos:msg-outgoing]
... ...
@@ -114,8 +114,8 @@ Chapter 1. Admin Guide
114 114
         3.13. xavu_cfg (str)
115 115
         3.14. xavu_filed_a_contact (str)
116 116
         3.15. xavu_filed_b_contact (str)
117
-        3.16. rr_update (int)
118
-        3.17. xavu_field_contact_host (str)
117
+        3.16. xavu_field_contact_host (str)
118
+        3.17. rr_update (int)
119 119
         3.18. context (str)
120 120
 
121 121
    4. Functions
... ...
@@ -184,8 +184,8 @@ Chapter 1. Admin Guide
184 184
    3.13. xavu_cfg (str)
185 185
    3.14. xavu_filed_a_contact (str)
186 186
    3.15. xavu_filed_b_contact (str)
187
-   3.16. rr_update (int)
188
-   3.17. xavu_field_contact_host (str)
187
+   3.16. xavu_field_contact_host (str)
188
+   3.17. rr_update (int)
189 189
    3.18. context (str)
190 190
 
191 191
 3.1. storage (str)
... ...
@@ -385,7 +385,7 @@ modparam("topos", "cparam_name", "xyz")
385 385
 
386 386
    Default value is “NULL” (disabled).
387 387
 
388
-   Example 1.13. Set xavu_filed_a_contact parameter
388
+   Example 1.13. Set xavu_cfg parameter
389 389
 ...
390 390
 modparam("topos", "xavu_cfg", "_tps_")
391 391
 modparam("topos", "xavu_filed_a_contact", "a_contact")
... ...
@@ -426,19 +426,7 @@ modparam("topos", "xavu_filed_b_contact", "b_contact")
426 426
 
427 427
 ...
428 428
 
429
-3.16. rr_update (int)
430
-
431
-   If set to 1, topos module will track and update record route changes on
432
-   re-invite.
433
-
434
-   Default value is 0 (do not update record route changes within dialog).
435
-
436
-   Example 1.16. Set rr_update parameter
437
-...
438
-modparam("topos", "rr_update", 1)
439
-...
440
-
441
-3.17. xavu_field_contact_host (str)
429
+3.16. xavu_field_contact_host (str)
442 430
 
443 431
    Control from where to take the host part of the Contact header added by
444 432
    topos. This parameter allows to take the value from an XAVU during
... ...
@@ -450,7 +438,7 @@ modparam("topos", "rr_update", 1)
450 438
 
451 439
    Default value is empty, not set.
452 440
 
453
-   Example 1.17. Set xavu_field_contact_host parameter
441
+   Example 1.16. Set xavu_field_contact_host parameter
454 442
 ...
455 443
 modparam("topos", "xavu_cfg", "_tps_")
456 444
 modparam("topos", "xavu_contact_host", "contact_host")
... ...
@@ -458,6 +446,18 @@ modparam("topos", "xavu_contact_host", "contact_host")
458 446
     $xavu(_tps_=>contact_host) = "kamailio.org";
459 447
 ...
460 448
 
449
+3.17. rr_update (int)
450
+
451
+   If set to 1, topos module will track and update record route changes on
452
+   re-invite.
453
+
454
+   Default value is 0 (do not update record route changes within dialog).
455
+
456
+   Example 1.17. Set rr_update parameter
457
+...
458
+modparam("topos", "rr_update", 1)
459
+...
460
+
461 461
 3.18. context (str)
462 462
 
463 463
    Set the global context for topos instance.
Browse code

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

Kamailio Dev authored on 01/04/2021 07:16:14
Showing 1 changed files
... ...
@@ -43,15 +43,23 @@ Frederic Gaisnon
43 43
               3.10. contact_host (str)
44 44
               3.11. contact_mode (int)
45 45
               3.12. cparam_name (int)
46
-              3.13. a_contact_avp (str)
47
-              3.14. b_contact_avp (str)
48
-              3.15. rr_update (int)
49
-              3.16. contact_host_avp (str)
46
+              3.13. xavu_cfg (str)
47
+              3.14. xavu_filed_a_contact (str)
48
+              3.15. xavu_filed_b_contact (str)
49
+              3.16. rr_update (int)
50
+              3.17. xavu_field_contact_host (str)
51
+              3.18. context (str)
50 52
 
51
-        4. Event Routes
53
+        4. Functions
52 54
 
53
-              4.1. event_route[topos:msg-outgoing]
54
-              4.2. event_route[topos:msg-sending]
55
+              4.1. tps_set_context(ctx)
56
+
57
+        5. Event Routes
58
+
59
+              5.1. event_route[topos:msg-outgoing]
60
+              5.2. event_route[topos:msg-sending]
61
+              5.3. event_route[topos:msg-incoming]
62
+              5.4. event_route[topos:msg-receiving]
55 63
 
56 64
    List of Examples
57 65
 
... ...
@@ -67,12 +75,17 @@ Frederic Gaisnon
67 75
    1.10. Set contact_host parameter
68 76
    1.11. Set contact_mode parameter
69 77
    1.12. Set cparam_name parameter
70
-   1.13. Set a_contact_avp parameter
71
-   1.14. Set b_contact_avp parameter
72
-   1.15. Set rr_update parameter
73
-   1.16. Set contact_host_avp parameter
74
-   1.17. Usage of event_route[topos:msg-outgoing]
75
-   1.18. Usage of event_route[topos:msg-sending]
78
+   1.13. Set xavu_filed_a_contact parameter
79
+   1.14. Set xavu_filed_a_contact parameter
80
+   1.15. Set xavu_filed_b_contact parameter
81
+   1.16. Set rr_update parameter
82
+   1.17. Set xavu_field_contact_host parameter
83
+   1.18. Set context parameter
84
+   1.19. tps_set_context usage
85
+   1.20. Usage of event_route[topos:msg-outgoing]
86
+   1.21. Usage of event_route[topos:msg-sending]
87
+   1.22. Usage of event_route[topos:msg-incoming]
88
+   1.23. Usage of event_route[topos:msg-receoving]
76 89
 
77 90
 Chapter 1. Admin Guide
78 91
 
... ...
@@ -98,15 +111,23 @@ Chapter 1. Admin Guide
98 111
         3.10. contact_host (str)
99 112
         3.11. contact_mode (int)
100 113
         3.12. cparam_name (int)
101
-        3.13. a_contact_avp (str)
102
-        3.14. b_contact_avp (str)
103
-        3.15. rr_update (int)
104
-        3.16. contact_host_avp (str)
114
+        3.13. xavu_cfg (str)
115
+        3.14. xavu_filed_a_contact (str)
116
+        3.15. xavu_filed_b_contact (str)
117
+        3.16. rr_update (int)
118
+        3.17. xavu_field_contact_host (str)
119
+        3.18. context (str)
120
+
121
+   4. Functions
122
+
123
+        4.1. tps_set_context(ctx)
105 124
 
106
-   4. Event Routes
125
+   5. Event Routes
107 126
 
108
-        4.1. event_route[topos:msg-outgoing]
109
-        4.2. event_route[topos:msg-sending]
127
+        5.1. event_route[topos:msg-outgoing]
128
+        5.2. event_route[topos:msg-sending]
129
+        5.3. event_route[topos:msg-incoming]
130
+        5.4. event_route[topos:msg-receiving]
110 131
 
111 132
 1. Overview
112 133
 
... ...
@@ -160,10 +181,12 @@ Chapter 1. Admin Guide
160 181
    3.10. contact_host (str)
161 182
    3.11. contact_mode (int)
162 183
    3.12. cparam_name (int)
163
-   3.13. a_contact_avp (str)
164
-   3.14. b_contact_avp (str)
165
-   3.15. rr_update (int)
166
-   3.16. contact_host_avp (str)
184
+   3.13. xavu_cfg (str)
185
+   3.14. xavu_filed_a_contact (str)
186
+   3.15. xavu_filed_b_contact (str)
187
+   3.16. rr_update (int)
188
+   3.17. xavu_field_contact_host (str)
189
+   3.18. context (str)
167 190
 
168 191
 3.1. storage (str)
169 192
 
... ...
@@ -283,7 +306,9 @@ end
283 306
 
284 307
    Control what event_route blocks to be executed. It is a bitmask of: 1 -
285 308
    execute event_route[topos:msg-outgoing]; 2 - execute
286
-   event_route[topos:msg-sending].
309
+   event_route[topos:msg-sending]; 4 execute
310
+   event_route[topos:msg-incoming]; 8 execute
311
+   event_route[topos:msg-receiving];.
287 312
 
288 313
    Default value is 3 (execute both event_route blocks).
289 314
 
... ...
@@ -295,10 +320,10 @@ modparam("topos", "event_mode", 2)
295 320
 3.10. contact_host (str)
296 321
 
297 322
    You may need to control the host part of the Contact header added by
298
-   topos. If the contact_host_avp parameter is set, this value is ignored.
299
-   For example when using TLS with TOPOS the remote UAS must be able to
300
-   open a new TLS socket to the contact header. In this case, the contact
301
-   header must contain a domain name with a trusted CA signed
323
+   topos. If the xavu_filed_contact_host parameter is set, this value is
324
+   ignored. For example when using TLS with TOPOS the remote UAS must be
325
+   able to open a new TLS socket to the contact header. In this case, the
326
+   contact header must contain a domain name with a trusted CA signed
302 327
    certitificate.
303 328
 
304 329
    Default value is taken from the Record-Route URI.
... ...
@@ -321,9 +346,9 @@ modparam("topos", "contact_host", "proxy.domain.com")
321 346
    the b-side contact user from the Contact header of the processed
322 347
    initial SIP request.
323 348
 
324
-   If you use the mode (2), you need to configure the a_contact_avp and
325
-   b_contact_avp parameter. Furthermore you need to assign values to them
326
-   during the processing of the initial SIP request.
349
+   If you use the mode (2), you need to configure the xavu_field_a_contact
350
+   and xavu_field_b_contact parameter. Furthermore you need to assign
351
+   values to them during the processing of the initial SIP request.
327 352
 
328 353
    The name of the Contact URI parameter can be customized with the
329 354
    cparam_name parameter.
... ...
@@ -350,65 +375,130 @@ modparam("topos", "contact_mode", 1)
350 375
 modparam("topos", "cparam_name", "xyz")
351 376
 ...
352 377
 
353
-3.13. a_contact_avp (str)
378
+3.13. xavu_cfg (str)
379
+
380
+   Name of root XAVU to hold config-specific values to be used by module
381
+   at runtime.
382
+
383
+   Note: this parameter must be set if any other parameter prefixed with
384
+   `xavu_field_` is used.
385
+
386
+   Default value is “NULL” (disabled).
387
+
388
+   Example 1.13. Set xavu_filed_a_contact parameter
389
+...
390
+modparam("topos", "xavu_cfg", "_tps_")
391
+modparam("topos", "xavu_filed_a_contact", "a_contact")
392
+...
393
+    $xavu(_tps_=>a_contact) = "...";
394
+...
395
+
396
+3.14. xavu_filed_a_contact (str)
354 397
 
355
-   Name of the AVP parameter to evaluate for the A-side Contact Header
356
-   user part. This parameter is only necessary in contact_mode (2).
398
+   Name of the field inside root XAVU specifed by `xavu_cfg` to evaluate
399
+   for the A-side Contact Header user part. This parameter is only
400
+   necessary in contact_mode (2).
357 401
 
358 402
    Default value is “NULL” (disabled).
359 403
 
360
-   Example 1.13. Set a_contact_avp parameter
404
+   Example 1.14. Set xavu_filed_a_contact parameter
361 405
 ...
362
-modparam("topos", "a_contact_avp", "$avp(tps-act)")
406
+modparam("topos", "xavu_cfg", "_tps_")
407
+modparam("topos", "xavu_filed_a_contact", "a_contact")
408
+...
409
+    $xavu(_tps_=>a_contact) = "...";
363 410
 ...
364 411
 
365
-3.14. b_contact_avp (str)
412
+3.15. xavu_filed_b_contact (str)
366 413
 
367
-   Name of the AVP parameter to evaluate for the B-side Contact Header
368
-   user part. This parameter is only necessary in contact_mode (2).
414
+   Name of the field inside root XAVU specifed by `xavu_cfg` to evaluate
415
+   for the B-side Contact Header user part. This parameter is only
416
+   necessary in contact_mode (2).
369 417
 
370 418
    Default value is “NULL” (disabled).
371 419
 
372
-   Example 1.14. Set b_contact_avp parameter
420
+   Example 1.15. Set xavu_filed_b_contact parameter
421
+...
422
+modparam("topos", "xavu_cfg", "_tps_")
423
+modparam("topos", "xavu_filed_b_contact", "b_contact")
373 424
 ...
374
-modparam("topos", "b_contact_avp", "$avp(tps-bct)")
425
+    $xavu(_tps_=>b_contact) = "...";
426
+
375 427
 ...
376 428
 
377
-3.15. rr_update (int)
429
+3.16. rr_update (int)
378 430
 
379 431
    If set to 1, topos module will track and update record route changes on
380 432
    re-invite.
381 433
 
382 434
    Default value is 0 (do not update record route changes within dialog).
383 435
 
384
-   Example 1.15. Set rr_update parameter
436
+   Example 1.16. Set rr_update parameter
385 437
 ...
386 438
 modparam("topos", "rr_update", 1)
387 439
 ...
388 440
 
389
-3.16. contact_host_avp (str)
441
+3.17. xavu_field_contact_host (str)
390 442
 
391
-   You may need to control the host part of the Contact header added by
392
-   topos. This parameter allows to take the value from an AVP during
393
-   run-time. If this parameter is set, the contact_host parameter is
394
-   ignored. For example when using TLS with TOPOS the remote UAS must be
395
-   able to open a new TLS socket to the contact header. In this case, the
396
-   contact header must contain a domain name with a trusted CA signed
397
-   certitificate.
443
+   Control from where to take the host part of the Contact header added by
444
+   topos. This parameter allows to take the value from an XAVU during
445
+   run-time, it specifies the field inside XAVU "xavu_cfg". If this
446
+   parameter is set, the contact_host parameter is ignored. For example
447
+   when using TLS with TOPOS the remote UAS must be able to open a new TLS
448
+   socket to the contact header. In this case, the contact header must
449
+   contain a domain name with a trusted CA signed certitificate.
398 450
 
399 451
    Default value is empty, not set.
400 452
 
401
-   Example 1.16. Set contact_host_avp parameter
453
+   Example 1.17. Set xavu_field_contact_host parameter
454
+...
455
+modparam("topos", "xavu_cfg", "_tps_")
456
+modparam("topos", "xavu_contact_host", "contact_host")
457
+...
458
+    $xavu(_tps_=>contact_host) = "kamailio.org";
459
+...
460
+
461
+3.18. context (str)
462
+
463
+   Set the global context for topos instance.
464
+
465
+   The value has to be maximum 12 characters.
466
+
467
+   Default value is “NULL” (disabled).
468
+
469
+   Example 1.18. Set context parameter
470
+...
471
+modparam("topos", "context", "srvone")
472
+...
473
+
474
+4. Functions
475
+
476
+   4.1. tps_set_context(ctx)
477
+
478
+4.1.  tps_set_context(ctx)
479
+
480
+   Update the context at runtime. If the value is emtpy string, then the
481
+   runtime context is reset.
482
+
483
+   This function can be used from ANY_ROUTE.
484
+
485
+   Example 1.19. tps_set_context usage
402 486
 ...
403
-modparam("topos", "contact_host_avp", "$avp(contact_host)")
487
+request_route {
488
+    ...
489
+    tps_set_context("srvone");
490
+    ...
491
+}
404 492
 ...
405 493
 
406
-4. Event Routes
494
+5. Event Routes
407 495
 
408
-   4.1. event_route[topos:msg-outgoing]
409
-   4.2. event_route[topos:msg-sending]
496
+   5.1. event_route[topos:msg-outgoing]
497
+   5.2. event_route[topos:msg-sending]
498
+   5.3. event_route[topos:msg-incoming]
499
+   5.4. event_route[topos:msg-receiving]
410 500
 
411
-4.1. event_route[topos:msg-outgoing]
501
+5.1. event_route[topos:msg-outgoing]
412 502
 
413 503
    It is executed before doing topology stripping processing for an
414 504
    outgoing SIP message. If 'drop' is executed inside the event route,
... ...
@@ -420,7 +510,7 @@ modparam("topos", "contact_host_avp", "$avp(contact_host)")
420 510
    reparsing the outgoing SIP message for the cases when topology hiding
421 511
    is not wanted.
422 512
 
423
-   Example 1.17. Usage of event_route[topos:msg-outgoing]
513
+   Example 1.20. Usage of event_route[topos:msg-outgoing]
424 514
 ...
425 515
 event_route[topos:msg-outgoing] {
426 516
   if($sndto(ip)=="10.1.1.10") {
... ...
@@ -429,7 +519,7 @@ event_route[topos:msg-outgoing] {
429 519
 }
430 520
 ...
431 521
 
432
-4.2. event_route[topos:msg-sending]
522
+5.2. event_route[topos:msg-sending]
433 523
 
434 524
    It is executed before doing topology stripping processing for a SIP
435 525
    message to be sent out, being executed after
... ...
@@ -439,7 +529,7 @@ event_route[topos:msg-outgoing] {
439 529
    $sndto(proto) point to the destination. The SIP message is the one to
440 530
    be sent out.
441 531
 
442
-   Example 1.18. Usage of event_route[topos:msg-sending]
532
+   Example 1.21. Usage of event_route[topos:msg-sending]
443 533