Browse code

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

Kamailio Dev authored on 30/09/2022 09:46:18
Showing 1 changed files
... ...
@@ -41,7 +41,7 @@ Lucian Balaceanu
41 41
 
42 42
         4. Functions
43 43
 
44
-              4.1. cr_user_carrier(user, domain, dstavp)
44
+              4.1. cr_user_carrier(user, domain, dstvar)
45 45
               4.2. cr_route(carrier, domain, prefix_matching,
46 46
                       rewrite_user, hash_source, descavp)
47 47
 
... ...
@@ -185,7 +185,7 @@ Chapter 1. Admin Guide
185 185
 
186 186
    4. Functions
187 187
 
188
-        4.1. cr_user_carrier(user, domain, dstavp)
188
+        4.1. cr_user_carrier(user, domain, dstvar)
189 189
         4.2. cr_route(carrier, domain, prefix_matching, rewrite_user,
190 190
                 hash_source, descavp)
191 191
 
... ...
@@ -473,7 +473,7 @@ modparam("carrierroute", "avoid_failed_destinations", 0)
473 473
 
474 474
 4. Functions
475 475
 
476
-   4.1. cr_user_carrier(user, domain, dstavp)
476
+   4.1. cr_user_carrier(user, domain, dstvar)
477 477
    4.2. cr_route(carrier, domain, prefix_matching, rewrite_user,
478 478
           hash_source, descavp)
479 479
 
... ...
@@ -501,22 +501,23 @@ cr_user_rewrite_uri(uri, domain)
501 501
 cr_tree_rewrite_uri(tree, domain)
502 502
 -> cr_route(tree, domain, "$rU", "$rU", "call_id")
503 503
 
504
-4.1.  cr_user_carrier(user, domain, dstavp)
504
+4.1.  cr_user_carrier(user, domain, dstvar)
505 505
 
506
-   This function loads the carrier and stores it in an AVP. It cannot be
507
-   used in the config file mode, as it needs a mapping of the given user
508
-   to a certain carrier. The is derived from a database entry belonging to
509
-   the user parameter. This mapping must be available in the table that is
510
-   specified in the “subscriber_table” variable. This data is not cached
511
-   in memory, that means for every execution of this function a database
512
-   query will be done.
506
+   This function loads the carrier and stores it in a config variable. It
507
+   cannot be used in the config file mode, as it needs a mapping of the
508
+   given user to a certain carrier. The is derived from a database entry
509
+   belonging to the user parameter. This mapping must be available in the
510
+   table that is specified in the “subscriber_table” variable. This data
511
+   is not cached in memory, that means for every execution of this
512
+   function a database query will be done.
513 513
 
514 514
    Meaning of the parameters is as follows:
515 515
      * user - Name of the user for the carrier tree lookup. Additional to
516 516
        a string any pseudo-variable could be used as input.
517 517
      * domain - Name of the routing domain to be used. Additional to a
518 518
        string any pseudo-variable could be used as input.
519
-     * dstavp - Name of the AVP where to store the carrier id.
519
+     * dstvar - Name of the writaable variable (e.g., an AVP) where to
520
+       store the carrier id.
520 521
 
521 522
 4.2.  cr_route(carrier, domain, prefix_matching, rewrite_user, hash_source,
522 523
 descavp)