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

CorrelationFilter Class

Represents the correlation filter expression.

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

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

The CorrelationFilter type exposes the following members.

  Name Description
Public method CorrelationFilter Initializes a new instance of the CorrelationFilter class with the specified correlation identifier.
Top
  Name Description
Public property CorrelationId Gets the identifier of the correlation.
Public property RequiresPreprocessing Gets a value indicating whether the CorrelationFilter expression requires preprocessing. (Overrides Filter.RequiresPreprocessing.)
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 Indicates whether a message matches against the current SQL expression. (Overrides Filter.Match(BrokeredMessage).)
Protected method MemberwiseClone (Inherited from Object.)
Public method Preprocess Gets the preprocessed filter expression. (Overrides Filter.Preprocess().)
Public method ToString (Inherited from Object.)
Public method Validate Validates the CorrelationFilter object. (Overrides Filter.Validate().)
Top
  Name Description
Explicit interface implemetation Private property IExtensibleDataObject.ExtensionData Gets or sets the object that contains extra data. (Inherited from Filter.)
Top

The CorrelationFilter provides an efficient shortcut for declarations of filters that deal only with correlation equality. In this case the cost of the lexicographical analysis of the expression can be avoided. Not only will correlation filters be optimized at declaration time, but they will also be optimized at runtime. Correlation filter matching can be reduced to a hashtable lookup, which aggregates the complexity of the set of defined correlation filters to 0(1).

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)