Browse code

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

Kamailio Dev authored on 17/12/2019 18:31:12
Showing 1 changed files
... ...
@@ -117,7 +117,7 @@ Daniel-Constantin Mierla
117 117
               4.36. t_lookup_cancel([1])
118 118
               4.37. t_drop_replies([mode])
119 119
               4.38. t_save_lumps()
120
-              4.39. t_load_contacts()
120
+              4.39. t_load_contacts([mode])
121 121
               4.40. t_next_contacts()
122 122
               4.41. t_next_contact_flow()
123 123
               4.42. t_check_status(re)
... ...
@@ -372,7 +372,7 @@ Chapter 1. Admin Guide
372 372
         4.36. t_lookup_cancel([1])
373 373
         4.37. t_drop_replies([mode])
374 374
         4.38. t_save_lumps()
375
-        4.39. t_load_contacts()
375
+        4.39. t_load_contacts([mode])
376 376
         4.40. t_next_contacts()
377 377
         4.41. t_next_contact_flow()
378 378
         4.42. t_check_status(re)
... ...
@@ -1724,7 +1724,7 @@ modparam("tm", "rich_redirect", 3)
1724 1724
    4.36. t_lookup_cancel([1])
1725 1725
    4.37. t_drop_replies([mode])
1726 1726
    4.38. t_save_lumps()
1727
-   4.39. t_load_contacts()
1727
+   4.39. t_load_contacts([mode])
1728 1728
    4.40. t_next_contacts()
1729 1729
    4.41. t_next_contact_flow()
1730 1730
    4.42. t_check_status(re)
... ...
@@ -2473,7 +2473,7 @@ failure_route[1] {
2473 2473
         t_relay();
2474 2474
 }
2475 2475
 
2476
-4.39.  t_load_contacts()
2476
+4.39.  t_load_contacts([mode])
2477 2477
 
2478 2478
    This is the first of the three functions that can be used to implement
2479 2479
    serial/parallel forking based on q and +sip.instance values of
... ...
@@ -2489,18 +2489,33 @@ failure_route[1] {
2489 2489
    nothing.
2490 2490
 
2491 2491
    If the current destination set contains more than one branch, the
2492
-   function sorts them according to increasing value of the q parameter
2493
-   and then stores the branches in reverse order into the XAVP.
2492
+   function sorts them according to the algorithm selected with the 'mode'
2493
+   paramenter and then stores the branches in reverse order into the XAVP.
2494 2494
 
2495 2495
    The q parameter of a branch contains a value from range 0-1.0 and it
2496 2496
    expresses relative preference of the branch among all branches in the
2497 2497
    destination set. The higher the q value the more preference the user
2498
-   agent gave to the branch. Branches with higher q values will be tried
2499
-   before branches with lower ones when serial forking takes place.
2498
+   agent gave to the branch. The parameter 'mode' controls which type of
2499
+   algorithm kamailio will apply to sort the branches based on the q
2500
+   values:
2501
+
2502
+   - '0' or missing: branches with higher q values will be tried before
2503
+   branches with lower ones when serial forking takes place Equals q
2504
+   values will result in a parallel forking.
2505
+
2506
+   - '1': branches are ordered using a proportional algorithm that uses to
2507
+   q value as the weight of the branch. Higher is the q value, higher is
2508
+   the probability to be tried as first. Equals q values means equals
2509
+   probability to be tried. Differently from the previous mode there is no
2510
+   possibility to have parallel forking. Branches with q values equals to
2511
+   0 or lower are not considered by the ordering algorithm, but just added
2512
+   at the end of the list as backup option if all other branches fail.
2513
+   This algorithm can be useful in case of endpoints in ACTIVE-ACTIVE
2514
+   configuration to load-balance the calls.
2500 2515
 
2501 2516
    After calling t_load_contacts(), function t_next_contacts() and
2502 2517
    possibly also t_next_contact_flow() need to be called one or more times
2503
-   in order to retrieve the branches based on their q value.
2518
+   in order to retrieve the branches based on their order.
2504 2519
 
2505 2520
    Function returns 1 if loading of contacts succeeded or there was
2506 2521
    nothing to do. In case of an error, function returns -1 (see syslog).