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)

[DataContractAttribute(Name = "CorrelationFilter", Namespace = "http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]
[KnownTypeAttribute(typeof(DateTimeOffset))]
public sealed class CorrelationFilter : Filter

The CorrelationFilter type exposes the following members.

Constructors

	Name	Description
	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.

Top

Properties

	Name	Description
	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. (Overrides Filter.RequiresPreprocessing.)
	SessionId	Gets the session identifier.
	To	Gets the address to send to.

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	Match	Indicates whether a message matches against the current SQL expression. (Overrides Filter.Match(BrokeredMessage).)
	Preprocess	Gets the preprocessed filter expression. (Overrides Filter.Preprocess().)
	ToString	(Inherited from Object.)
	Validate	Validates the CorrelationFilter object. (Overrides Filter.Validate().)

Top

Remarks

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).

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Reference

Microsoft.ServiceBus.Messaging Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD