Browse code

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

Kamailio Dev authored on 03/09/2018 11:01:47
Showing 1 changed files
... ...
@@ -47,6 +47,7 @@ Bogdan-Andrei Iancu
47 47
               4.5. enable_socket_mismatch_warning (integer)
48 48
               4.6. custom_user_avp (avp string)
49 49
               4.7. force_send_socket (int)
50
+              4.8. ignore_sips (int)
50 51
 
51 52
         5. Functions
52 53
 
... ...
@@ -88,15 +89,16 @@ Bogdan-Andrei Iancu
88 89
    1.7. enable_socket_mismatch_warning usage
89 90
    1.8. custom_user_avp usage
90 91
    1.9. Set force_send_socket parameter
91
-   1.10. loose_route usage
92
-   1.11. record_route usage
93
-   1.12. remove_record_route usage
94
-   1.13. record_route_preset usage
95
-   1.14. record_route_advertised_address usage
96
-   1.15. add_rr_param usage
97
-   1.16. check_route_param usage
98
-   1.17. is_direction usage
99
-   1.18. $route_uri
92
+   1.10. Set ignore_sips parameter
93
+   1.11. loose_route usage
94
+   1.12. record_route usage
95
+   1.13. remove_record_route usage
96
+   1.14. record_route_preset usage
97
+   1.15. record_route_advertised_address usage
98
+   1.16. add_rr_param usage
99
+   1.17. check_route_param usage
100
+   1.18. is_direction usage
101
+   1.19. $route_uri
100 102
    2.1. record_route usage
101 103
    2.2. record_route_advertised_address usage
102 104
    2.3. Loading RR module's API from another module
... ...
@@ -121,6 +123,7 @@ Chapter 1. Admin Guide
121 123
         4.5. enable_socket_mismatch_warning (integer)
122 124
         4.6. custom_user_avp (avp string)
123 125
         4.7. force_send_socket (int)
126
+        4.8. ignore_sips (int)
124 127
 
125 128
    5. Functions
126 129
 
... ...
@@ -215,6 +218,7 @@ UAC                       Kamailio PROXY                          UAS
215 218
    4.5. enable_socket_mismatch_warning (integer)
216 219
    4.6. custom_user_avp (avp string)
217 220
    4.7. force_send_socket (int)
221
+   4.8. ignore_sips (int)
218 222
 
219 223
 4.1. enable_full_lr (integer)
220 224
 
... ...
@@ -343,6 +347,18 @@ record_route();
343 347
 modparam("rr", "force_send_socket", 1)
344 348
 ...
345 349
 
350
+4.8. ignore_sips (int)
351
+
352
+   If set to 1, the Record-Route header are build with 'sip' schema
353
+   always, ignoring the presence of 'sips' schema in request URI.
354
+
355
+   Default value is 0 (use 'sips' if present in R-URI).
356
+
357
+   Example 1.10. Set ignore_sips parameter
358
+...
359
+modparam("rr", "ignore_sips", 1)
360
+...
361
+
346 362
 5. Functions
347 363
 
348 364
    5.1. loose_route()
... ...
@@ -395,7 +411,7 @@ modparam("rr", "force_send_socket", 1)
395 411
 
396 412
    This function can be used from REQUEST_ROUTE.
397 413
 
398
-   Example 1.10. loose_route usage
414
+   Example 1.11. loose_route usage
399 415
 ...
400 416
 loose_route();
401 417
 ...
... ...
@@ -418,7 +434,7 @@ loose_route();
418 434
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE and
419 435
    FAILURE_ROUTE.
420 436
 
421
-   Example 1.11. record_route usage
437
+   Example 1.12. record_route usage
422 438
 ...
423 439
 record_route();
424 440
 ...
... ...
@@ -432,7 +448,7 @@ record_route();
432 448
 
433 449
    This function can be used from REQUEST_ROUTE and FAILURE_ROUTE.
434 450
 
435
-   Example 1.12. remove_record_route usage
451
+   Example 1.13. remove_record_route usage
436 452
 ...
437 453
 remove_record_route();
438 454
 ...
... ...
@@ -460,7 +476,7 @@ remove_record_route();
460 476
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE and
461 477
    FAILURE_ROUTE.
462 478
 
463
-   Example 1.13. record_route_preset usage
479
+   Example 1.14. record_route_preset usage
464 480
 ...
465 481
 record_route_preset("1.2.3.4:5090");
466 482
 ...
... ...
@@ -487,7 +503,7 @@ record_route_preset("1.2.3.4:5090");
487 503
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE and
488 504
    FAILURE_ROUTE.
489 505
 
490
-   Example 1.14. record_route_advertised_address usage
506
+   Example 1.15. record_route_advertised_address usage
491 507
 ...
492 508
 record_route_advertised_address("1.2.3.4:5080");
493 509
 ...
... ...
@@ -506,7 +522,7 @@ record_route_advertised_address("1.2.3.4:5080");
506 522
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE and
507 523
    FAILURE_ROUTE.
508 524
 
509
-   Example 1.15. add_rr_param usage
525
+   Example 1.16. add_rr_param usage
510 526
 ...
511 527
 add_rr_param(";nat=yes");
512 528
 ...
... ...
@@ -522,7 +538,7 @@ add_rr_param(";nat=yes");
522 538
 
523 539
    This function can be used from REQUEST_ROUTE.
524 540
 
525
-   Example 1.16. check_route_param usage
541
+   Example 1.17. check_route_param usage
526 542
 ...
527 543
 if (check_route_param("nat=yes")) {
528 544
     setflag(6);
... ...
@@ -549,7 +565,7 @@ if (check_route_param("nat=yes")) {
549 565
 
550 566
    This function can be used from REQUEST_ROUTE.
551 567
 
552
-   Example 1.17. is_direction usage
568
+   Example 1.18. is_direction usage
553 569
 ...
554 570
 if (is_direction("downstream")) {
555 571
     xdbg("in-dialog request from caller to callee (downstream) ($rm)\n");
... ...
@@ -566,7 +582,7 @@ if (is_direction("downstream")) {
566 582
 
567 583
    Returns the URI of the top route-header.
568 584
 
569
-   Example 1.18. $route_uri
585
+   Example 1.19. $route_uri
570 586
 ...
571 587
     xdbg("Route-URI is: $route_uri\n");
572 588
 ...