aboutsummaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorAnders Svensson <[email protected]>2012-08-30 09:26:26 +0200
committerAnders Svensson <[email protected]>2012-08-30 09:26:26 +0200
commit3b8c54429b4da595f72bc6c2738bd03ba03ab80c (patch)
treeae27a0e91e374b929590c50e0b6a03e7a6900bc5 /lib
parentbacef78cef7998e5b71bf69c12e510d716cdea0a (diff)
downloadotp-3b8c54429b4da595f72bc6c2738bd03ba03ab80c.tar.gz
otp-3b8c54429b4da595f72bc6c2738bd03ba03ab80c.tar.bz2
otp-3b8c54429b4da595f72bc6c2738bd03ba03ab80c.zip
Add warning about 'host' filter
Diffstat (limited to 'lib')
-rw-r--r--lib/diameter/doc/src/diameter.xml17
1 files changed, 13 insertions, 4 deletions
diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index fdd18929df..0bfbf62cd3 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -463,6 +463,10 @@ specified list.</p>
</taglist>
+<p>
+An invalid filter is equivalent to <c>{any,[]}</c>, a filter
+that matches no peer.</p>
+
<note>
<p>
The <c>host</c> and <c>realm</c> filters examine the
@@ -473,13 +477,18 @@ the message contains at most one of each AVP.
If this is not the case then the <c>{host|realm, <seealso
marker="diameter_dict#DATA_TYPES">DiameterIdentity()</seealso>}</c>
filters must be used to achieve the desired result.
-An empty host/realm (which should not be typical)
-is equivalent to an unspecified one for the purposes of filtering.</p>
+An empty <c><seealso
+marker="diameter_dict#DATA_TYPES">DiameterIdentity()</seealso></c>
+(which should not be typical)
+matches all hosts/realms for the purposes of filtering.</p>
</note>
+<warning>
<p>
-An invalid filter is equivalent to <c>{any,[]}</c>, a filter
-that matches no peer.</p>
+A <c>host</c> filter is not typically desirable when setting
+Destination-Host since it will remove peer agents from the
+candidates list.</p>
+</warning>
<marker id="service_event"/>
</item>