CorrelationFilter CorrelationFilter CorrelationFilter CorrelationFilter CorrelationFilter CorrelationFilter Class

Definition

Represents the correlation filter expression. For more information about filters, see the Topic Filters sample.

public ref class CorrelationFilter sealed : Microsoft::ServiceBus::Messaging::Filter
public ref class CorrelationFilter sealed : Microsoft::ServiceBus::Messaging::Filter
class CorrelationFilter sealed : 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))]
public sealed class CorrelationFilter : Microsoft.ServiceBus.Messaging.Filter
type CorrelationFilter = class
    inherit Filter
Public NotInheritable Class CorrelationFilter
Inherits Filter
Inheritance
CorrelationFilterCorrelationFilterCorrelationFilterCorrelationFilterCorrelationFilterCorrelationFilter
Attributes

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() CorrelationFilter() CorrelationFilter() CorrelationFilter() CorrelationFilter() CorrelationFilter()

Initializes a new instance of the CorrelationFilter class with default values.

CorrelationFilter(String) CorrelationFilter(String) CorrelationFilter(String) CorrelationFilter(String) CorrelationFilter(String) CorrelationFilter(String)

Initializes a new instance of the CorrelationFilter class with the specified correlation identifier.

Properties

ContentType ContentType ContentType ContentType ContentType ContentType

Gets the content type of the message.

CorrelationId CorrelationId CorrelationId CorrelationId CorrelationId CorrelationId

Gets the identifier of the correlation.

IExtensibleDataObject.ExtensionData IExtensibleDataObject.ExtensionData IExtensibleDataObject.ExtensionData IExtensibleDataObject.ExtensionData IExtensibleDataObject.ExtensionData IExtensibleDataObject.ExtensionData Inherited from Filter
Label Label Label Label Label Label

Gets the application specific label.

MessageId MessageId MessageId MessageId MessageId MessageId

Gets the identifier of the message.

Properties Properties Properties Properties Properties Properties

Gets the application specific properties of the message.

ReplyTo ReplyTo ReplyTo ReplyTo ReplyTo ReplyTo

Gets the address of the queue to reply to.

ReplyToSessionId ReplyToSessionId ReplyToSessionId ReplyToSessionId ReplyToSessionId ReplyToSessionId

Gets the session identifier to reply to.

RequiresPreprocessing RequiresPreprocessing RequiresPreprocessing RequiresPreprocessing RequiresPreprocessing RequiresPreprocessing

Gets a value indicating whether the CorrelationFilter expression requires preprocessing.

SessionId SessionId SessionId SessionId SessionId SessionId

Gets the session identifier.

To To To To To To

Gets the address to send to.

Methods

Match(BrokeredMessage) Match(BrokeredMessage) Match(BrokeredMessage) Match(BrokeredMessage) Match(BrokeredMessage) Match(BrokeredMessage)

Indicates whether a message matches against the current SQL expression.

Preprocess() Preprocess() Preprocess() Preprocess() Preprocess() Preprocess()

Gets the preprocessed filter expression.

ToString() ToString() ToString() ToString() ToString() ToString()

Converts the value of the current instance to its equivalent string representation.

Validate() Validate() Validate() Validate() Validate() Validate()

Validates the CorrelationFilter object.

Extension Methods

IsDefined(Object) IsDefined(Object) IsDefined(Object) IsDefined(Object) IsDefined(Object) IsDefined(Object)

Determines if a certain property is defined or not.

IsNull(Object) IsNull(Object) IsNull(Object) IsNull(Object) IsNull(Object) IsNull(Object)

Determines if a certain property is null or not.

IsPrimitive(Object) IsPrimitive(Object) IsPrimitive(Object) IsPrimitive(Object) IsPrimitive(Object) IsPrimitive(Object)

Determines if a certain property is of premitive JSON type.

Applies to