Skip to content

Commit

Permalink
Add warning about 'host' filter
Browse files Browse the repository at this point in the history
  • Loading branch information
Anders Svensson committed Aug 30, 2012
1 parent bacef78 commit 3b8c544
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions lib/diameter/doc/src/diameter.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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>
Expand Down

0 comments on commit 3b8c544

Please sign in to comment.