Export (0) Print
Expand All

CorrelationCallbackMessageProperty Class

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

System.Object
  System.ServiceModel.Channels.CorrelationCallbackMessageProperty

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

public abstract class CorrelationCallbackMessageProperty : IMessageProperty

The CorrelationCallbackMessageProperty type exposes the following members.

  NameDescription
Protected methodCorrelationCallbackMessageProperty(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.
Protected methodCorrelationCallbackMessageProperty(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.
Top

  NameDescription
Public propertyIsFullyDefinedDetermines whether the CorrelationCallbackMessageProperty has all of the required correlation data.
Public propertyStatic memberNameGets the name of this message property: “CorrelationCallbackMessageProperty”.
Public propertyNeededDataGets a list of correlation data that is required before correlation can be applied.
Top

  NameDescription
Public methodAddDataAdds required correlation data to the property.
Public methodBeginFinalizeCorrelationCalled by a correlation protocol when all of the correlation information is available to asynchronously construct the correlation.
Public methodCreateCopyWhen overridden in a derived class, initializes and returns a copy of the derived message property instance.
Public methodEndFinalizeCorrelationReturns the message that was prepared asynchronously for correlation.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFinalizeCorrelationCalled by a correlation protocol when all of the correlation information is available to construct the correlation.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnBeginFinalizeCorrelationWhen overridden in a derived class, asynchronously performs the correlation calculation for the specified message.
Protected methodOnEndFinalizeCorrelationWhen overridden in a derived class, returns the message that was prepared asynchronously for correlation.
Protected methodOnFinalizeCorrelationWhen overridden in a derived class, performs the correlation calculation for the specified message.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodStatic memberTryGet(Message, CorrelationCallbackMessageProperty)Attempts to get a CorrelationCallbackMessageProperty from the specified message’s Properties.
Public methodStatic memberTryGet(MessageProperties, CorrelationCallbackMessageProperty)Attempts to get a CorrelationCallbackMessageProperty from the specified message properties.
Top

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

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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