SALES: 1-800-867-1380

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)

[KnownTypeAttribute(typeof(DateTimeOffset))]
[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.

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

  NameDescription
Public propertyContentTypeGets the content type of the message.
Public propertyCorrelationIdGets the identifier of the correlation.
Public propertyLabelGets the application specific label.
Public propertyMessageIdGets the identifier of the message.
Public propertyPropertiesGets the application specific properties of the message.
Public propertyReplyToGets the address of the queue to reply to.
Public propertyReplyToSessionIdGets the session identifier to reply to.
Public propertyRequiresPreprocessingGets a value indicating whether the CorrelationFilter expression requires preprocessing. (Overrides Filter.RequiresPreprocessing.)
Public propertySessionIdGets the session identifier.
Public propertyToGets the address to send to.
Top

  NameDescription
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodMatchIndicates whether a message matches against the current SQL expression. (Overrides Filter.Match(BrokeredMessage).)
Public methodPreprocessGets the preprocessed filter expression. (Overrides Filter.Preprocess().)
Public methodToStringConverts the value of the current instance to its equivalent string representation. (Overrides Object.ToString().)
Public methodValidateValidates the CorrelationFilter object. (Overrides Filter.Validate().)
Top

  NameDescription
Explicit interface implemetationPrivate propertyIExtensibleDataObject.ExtensionDataGets 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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft