CorrelationCallbackMessageProperty Class

.NET Framework (current version)
 

Provides an abstract base class for deferring correlation key calculation until all of the correlation data is available.

Namespace:   System.ServiceModel.Channels
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

System.Object
  System.ServiceModel.Channels.CorrelationCallbackMessageProperty

public abstract class CorrelationCallbackMessageProperty : IMessageProperty

NameDescription
System_CAPS_protmethodCorrelationCallbackMessageProperty(CorrelationCallbackMessageProperty)

Called by derived classes to initialize a new instance of the derived class using the required correlation data from another CorrelationCallbackMessageProperty derived class instance.

System_CAPS_protmethodCorrelationCallbackMessageProperty(ICollection<String>)

Called by derived classes to initialize a new instance of the derived class using the specified collection of correlation data that is required to calculate the correlation.

NameDescription
System_CAPS_pubpropertyIsFullyDefined

Determines whether the CorrelationCallbackMessageProperty has all of the required correlation data.

System_CAPS_pubpropertySystem_CAPS_staticName

Gets the name of this message property: “CorrelationCallbackMessageProperty”.

System_CAPS_pubpropertyNeededData

Gets a list of correlation data that is required before correlation can be applied.

NameDescription
System_CAPS_pubmethodAddData(String, Func<String>)

Adds required correlation data to the property.

System_CAPS_pubmethodBeginFinalizeCorrelation(Message, TimeSpan, AsyncCallback, Object)

Called by a correlation protocol when all of the correlation information is available to asynchronously construct the correlation.

System_CAPS_pubmethodCreateCopy()

When overridden in a derived class, initializes and returns a copy of the derived message property instance.

System_CAPS_pubmethodEndFinalizeCorrelation(IAsyncResult)

Returns the message that was prepared asynchronously for correlation.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFinalizeCorrelation(Message, TimeSpan)

Called by a correlation protocol when all of the correlation information is available to construct the correlation.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnBeginFinalizeCorrelation(Message, TimeSpan, AsyncCallback, Object)

When overridden in a derived class, asynchronously performs the correlation calculation for the specified message.

System_CAPS_protmethodOnEndFinalizeCorrelation(IAsyncResult)

When overridden in a derived class, returns the message that was prepared asynchronously for correlation.

System_CAPS_protmethodOnFinalizeCorrelation(Message, TimeSpan)

When overridden in a derived class, performs the correlation calculation for the specified message.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticTryGet(Message, CorrelationCallbackMessageProperty)

Attempts to get a CorrelationCallbackMessageProperty from the specified message’s Properties.

System_CAPS_pubmethodSystem_CAPS_staticTryGet(MessageProperties, CorrelationCallbackMessageProperty)

Attempts to get a CorrelationCallbackMessageProperty from the specified message properties.

This is typically used to allow other channels to provide correlation data before a message is sent on the wire.

.NET Framework
Available since 4.0

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

Return to top
Show: