CorrelationFilter Class

Definition

Namespace:

Microsoft.ServiceBus.Messaging

Assembly:

Microsoft.ServiceBus.dll

Package:

WindowsAzure.ServiceBus v6.2.2

Represents the correlation filter expression.

[System.Runtime.Serialization.DataContract(Name="CorrelationFilter", Namespace="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]
[System.Runtime.Serialization.KnownType(typeof(System.DateTimeOffset))]
public sealed class CorrelationFilter : Microsoft.ServiceBus.Messaging.Filter

[<System.Runtime.Serialization.DataContract(Name="CorrelationFilter", Namespace="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")>]
[<System.Runtime.Serialization.KnownType(typeof(System.DateTimeOffset))>]
type CorrelationFilter = class
    inherit Filter

Public NotInheritable Class CorrelationFilter
Inherits Filter

Inheritance

Object

Filter

CorrelationFilter

Attributes

DataContractAttribute KnownTypeAttribute

Remarks

The CorrelationFilter provides an efficient shortcut for declarations of filters that deal only with correlation equality. In this case the cost of the lexigraphical 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 O(1).

Constructors

CorrelationFilter()	Initializes a new instance of the CorrelationFilter class with default values.
CorrelationFilter(String)	Initializes a new instance of the CorrelationFilter class with the specified correlation identifier.

Properties

ContentType	Gets the content type of the message.
CorrelationId	Gets the identifier of the correlation.
Label	Gets the application specific label.
MessageId	Gets the identifier of the message.
Properties	Gets the application specific properties of the message.
ReplyTo	Gets the address of the queue to reply to.
ReplyToSessionId	Gets the session identifier to reply to.
RequiresPreprocessing	Gets a value indicating whether the CorrelationFilter expression requires preprocessing.
SessionId	Gets the session identifier.
To	Gets the address to send to.

Methods

Match(BrokeredMessage)	Indicates whether a message matches against the current SQL expression.
Preprocess()	Gets the preprocessed filter expression.
ToString()	Converts the value of the current instance to its equivalent string representation.
Validate()	Validates the CorrelationFilter object.

Explicit Interface Implementations

IExtensibleDataObject.ExtensionData

(Inherited from Filter)