Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

Filter Class

Describes a filter expression that is evaluated against a BrokeredMessage.

System.Object
  Microsoft.ServiceBus.Messaging.Filter
    Microsoft.ServiceBus.Messaging.CorrelationFilter
    Microsoft.ServiceBus.Messaging.SqlFilter

Namespace:  Microsoft.ServiceBus.Messaging
Assembly:  Microsoft.ServiceBus (in Microsoft.ServiceBus.dll)
C#
C++
F#
JScript
VB
Copy 
[DataContractAttribute(Name = "Filter", Namespace = "http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]
[KnownTypeAttribute(typeof(TrueFilter))]
[KnownTypeAttribute(typeof(CorrelationFilter))]
[KnownTypeAttribute(typeof(SqlFilter))]
[KnownTypeAttribute(typeof(FalseFilter))]
public abstract class Filter : IExtensibleDataObject

The Filter type exposes the following members.

  Name Description
Public property RequiresPreprocessing Gets a value indicating whether the filter expression requires preprocessing.
Top
  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method Match Matches the BrokeredMessage against the FilterExpression.
Protected method MemberwiseClone (Inherited from Object.)
Public method Preprocess Preprocesses the filter expression and returns a preprocessed FilterExpression.
Public method ToString (Inherited from Object.)
Public method Validate Validates the FilterExpression and make sure it complies with the valid grammar rules.
Top
  Name Description
Explicit interface implemetation Private property IExtensibleDataObject.ExtensionData Gets or sets the object that contains extra data.
Top

FilterExpression is an abstract class with the following concrete implementations:

  1. SqlFilterExpression that represents a filter using SQL syntax.

  2. CorrelationFilter that provides an optimization for correlation equality expressions.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)