瀏覽代碼

- 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 16 年之前
父節點
當前提交
b516feb88c
共有 2 個文件被更改,包括 28 次插入9 次删除
  1. 14 5
      modules/carrierroute/README
  2. 14 4
      modules/carrierroute/doc/carrierroute_admin.xml

+ 14 - 5
modules/carrierroute/README

@@ -460,11 +460,20 @@ hash_source, dstavp)
    given hash source and algorithm. Returns -1 if there is no data
    found or an empty rewrite host on the longest match is found.
    Otherwise the rewritten host is stored in the given AVP (if
-   obmitted, the host is not stored in an AVP). This function is
-   only usable with rewrite_user and prefix_matching containing a
-   valid string. This string needs to be numerical if the
-   match_mode parameter is set to 10. It uses the standard crc32
-   algorithm to calculate the hash values.
+   obmitted, the host is not stored in an AVP).
+
+   This function is only usable with rewrite_user and
+   prefix_matching containing a valid string. This string needs to
+   be numerical if the match_mode parameter is set to 10. It uses
+   the standard CRC32 algorithm to calculate the hash values.
+
+   If flags and masks values are specified in the routing rule,
+   they will be compared by this function to the message flags.
+   Specify a flag and mask value of "0" to match to all possible
+   message flags (this is the default value). If flags and mask
+   are not zero, and no match to the message flags is possible, no
+   routing will be done. The calculation of the hash and the
+   load-balancing is done after the flags matching.
 
    Meaning of the parameters is as follows:
      * carrier - The routing tree to be used. Additional to a

+ 14 - 4
modules/carrierroute/doc/carrierroute_admin.xml

@@ -424,12 +424,22 @@ cr_tree_rewrite_uri(tree, domain)
         The Request URI is rewritten using rewrite_user and the given
         hash source and algorithm. Returns -1 if there is no data found
         or an empty rewrite host on the longest match is found. Otherwise
-				the rewritten host is stored in the given AVP (if obmitted, the
-				host is not stored in an AVP).
+        the rewritten host is stored in the given AVP (if obmitted, the
+        host is not stored in an AVP).
+        </para>
+        <para>
         This function is only usable with rewrite_user and prefix_matching
         containing a valid string. This string needs to be numerical if the match_mode
-		parameter is set to 10. It uses the standard crc32 algorithm to calculate
-		the hash values.
+        parameter is set to 10. It uses the standard CRC32 algorithm to calculate
+        the hash values.
+        </para>
+        <para>
+        If flags and masks values are specified in the routing rule, they will be
+        compared by this function to the message flags. Specify a flag and mask value of
+        <quote>0</quote> to match to all possible message flags (this is the default value).
+        If flags and mask are not zero, and no match to the message flags is possible, no
+        routing will be done. The calculation of the hash and the load-balancing is done
+        after the flags matching.
 	    </para>
 	    <para>Meaning of the parameters is as follows:</para>
 	    <itemizedlist>