Browse code

- add some explanations of the flag and mask matching to the msg

git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@5421 689a6050-402a-0410-94f2-e92a70836424

Henning Westerholt authored on 05/01/2009 16:09:22
Showing 2 changed files
... ...
@@ -460,11 +460,20 @@ hash_source, dstavp)
460 460
    given hash source and algorithm. Returns -1 if there is no data
461 461
    found or an empty rewrite host on the longest match is found.
462 462
    Otherwise the rewritten host is stored in the given AVP (if
463
-   obmitted, the host is not stored in an AVP). This function is
464
-   only usable with rewrite_user and prefix_matching containing a
465
-   valid string. This string needs to be numerical if the
466
-   match_mode parameter is set to 10. It uses the standard crc32
467
-   algorithm to calculate the hash values.
463
+   obmitted, the host is not stored in an AVP).
464
+
465
+   This function is only usable with rewrite_user and
466
+   prefix_matching containing a valid string. This string needs to
467
+   be numerical if the match_mode parameter is set to 10. It uses
468
+   the standard CRC32 algorithm to calculate the hash values.
469
+
470
+   If flags and masks values are specified in the routing rule,
471
+   they will be compared by this function to the message flags.
472
+   Specify a flag and mask value of "0" to match to all possible
473
+   message flags (this is the default value). If flags and mask
474
+   are not zero, and no match to the message flags is possible, no
475
+   routing will be done. The calculation of the hash and the
476
+   load-balancing is done after the flags matching.
468 477
 
469 478
    Meaning of the parameters is as follows:
470 479
      * carrier - The routing tree to be used. Additional to a
... ...
@@ -424,12 +424,22 @@ cr_tree_rewrite_uri(tree, domain)
424 424
         The Request URI is rewritten using rewrite_user and the given
425 425
         hash source and algorithm. Returns -1 if there is no data found
426 426
         or an empty rewrite host on the longest match is found. Otherwise
427
-				the rewritten host is stored in the given AVP (if obmitted, the
428
-				host is not stored in an AVP).
427
+        the rewritten host is stored in the given AVP (if obmitted, the
428
+        host is not stored in an AVP).
429
+        </para>
430
+        <para>
429 431
         This function is only usable with rewrite_user and prefix_matching
430 432
         containing a valid string. This string needs to be numerical if the match_mode
431
-		parameter is set to 10. It uses the standard crc32 algorithm to calculate
432
-		the hash values.
433
+        parameter is set to 10. It uses the standard CRC32 algorithm to calculate
434
+        the hash values.
435
+        </para>
436
+        <para>
437
+        If flags and masks values are specified in the routing rule, they will be
438
+        compared by this function to the message flags. Specify a flag and mask value of
439
+        <quote>0</quote> to match to all possible message flags (this is the default value).
440
+        If flags and mask are not zero, and no match to the message flags is possible, no
441
+        routing will be done. The calculation of the hash and the load-balancing is done
442
+        after the flags matching.
433 443
 	    </para>
434 444
 	    <para>Meaning of the parameters is as follows:</para>
435 445
 	    <itemizedlist>