CorrelationFilter CorrelationFilter Class

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

Syntax

Declaration

[DataContract(Name = "CorrelationFilter", Namespace = "http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]
[KnownType(typeof (DateTimeOffset))]
public sealed class CorrelationFilter : Filter, IExtensibleDataObject<DataContract(Name:="CorrelationFilter", Namespace:="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")>
<KnownType(GetType(DateTimeOffset))>
Public NotInheritable Class CorrelationFilter
    Inherits Filter
    Implements IExtensibleDataObject

Inheritance Hierarchy

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 summary

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

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

Properties summary

Gets the content type of the message.

Gets the identifier of the correlation.

Gets the application specific label.

Gets the identifier of the message.

Gets the application specific properties of the message.

Gets the address of the queue to reply to.

Gets the session identifier to reply to.

Gets a value indicating whether the CorrelationFilter expression requires preprocessing.

Gets the session identifier.

Gets the address to send to.

Methods summary

Indicates whether a message matches against the current SQL expression.

Gets the preprocessed filter expression.

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

Validates the CorrelationFilter object.

Constructors

  • CorrelationFilter()
    CorrelationFilter()

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

    public CorrelationFilter()Public Sub New
  • CorrelationFilter(String)
    CorrelationFilter(String)

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

    public CorrelationFilter(string correlationId)Public Sub New(correlationId As String)

    Parameters

    • correlationId

      The identifier for the correlation.

    Exceptions

Properties

  • ContentType
    ContentType

    Gets the content type of the message.

    [DataMember(Name = "ContentType", Order = 131079, EmitDefaultValue = false, IsRequired = false)]
    public string ContentType { get; set; }<DataMember(Name:="ContentType", Order:=131079, EmitDefaultValue:=False, IsRequired:=False)>
    Public Property ContentType As String

    Property Value

  • CorrelationId
    CorrelationId

    Gets the identifier of the correlation.

    [DataMember(Name = "CorrelationId", Order = 65537, EmitDefaultValue = false, IsRequired = false)]
    public string CorrelationId { get; set; }<DataMember(Name:="CorrelationId", Order:=65537, EmitDefaultValue:=False, IsRequired:=False)>
    Public Property CorrelationId As String

    Property Value

  • Label
    Label

    Gets the application specific label.

    [DataMember(Name = "Label", Order = 131076, EmitDefaultValue = false, IsRequired = false)]
    public string Label { get; set; }<DataMember(Name:="Label", Order:=131076, EmitDefaultValue:=False, IsRequired:=False)>
    Public Property Label As String

    Property Value

  • MessageId
    MessageId

    Gets the identifier of the message.

    [DataMember(Name = "MessageId", Order = 131073, EmitDefaultValue = false, IsRequired = false)]
    public string MessageId { get; set; }<DataMember(Name:="MessageId", Order:=131073, EmitDefaultValue:=False, IsRequired:=False)>
    Public Property MessageId As String

    Property Value

  • Properties
    Properties

    Gets the application specific properties of the message.

    public IDictionary<string, object> Properties { get; }Public ReadOnly Property Properties As IDictionary(Of String, Object)

    Property Value

  • ReplyTo
    ReplyTo

    Gets the address of the queue to reply to.

    [DataMember(Name = "ReplyTo", Order = 131075, EmitDefaultValue = false, IsRequired = false)]
    public string ReplyTo { get; set; }<DataMember(Name:="ReplyTo", Order:=131075, EmitDefaultValue:=False, IsRequired:=False)>
    Public Property ReplyTo As String

    Property Value

  • ReplyToSessionId
    ReplyToSessionId

    Gets the session identifier to reply to.

    [DataMember(Name = "ReplyToSessionId", Order = 131078, EmitDefaultValue = false, IsRequired = false)]
    public string ReplyToSessionId { get; set; }<DataMember(Name:="ReplyToSessionId", Order:=131078, EmitDefaultValue:=False, IsRequired:=False)>
    Public Property ReplyToSessionId As String

    Property Value

  • RequiresPreprocessing
    RequiresPreprocessing

    Gets a value indicating whether the CorrelationFilter expression requires preprocessing.

    public override bool RequiresPreprocessing { get; }Public Overrides ReadOnly Property RequiresPreprocessing As Boolean

    Property Value

    Overrides

  • SessionId
    SessionId

    Gets the session identifier.

    [DataMember(Name = "SessionId", Order = 131077, EmitDefaultValue = false, IsRequired = false)]
    public string SessionId { get; set; }<DataMember(Name:="SessionId", Order:=131077, EmitDefaultValue:=False, IsRequired:=False)>
    Public Property SessionId As String

    Property Value

  • To
    To

    Gets the address to send to.

    [DataMember(Name = "To", Order = 131074, EmitDefaultValue = false, IsRequired = false)]
    public string To { get; set; }<DataMember(Name:="To", Order:=131074, EmitDefaultValue:=False, IsRequired:=False)>
    Public Property To As String

    Property Value

Methods

Attributes

System.Runtime.Serialization.DataContractAttribute
System.Runtime.Serialization.KnownTypeAttribute

Details

Namespace

Microsoft.ServiceBus.Messaging

Assembly

Microsoft.ServiceBus.dll