CorrelationCallbackMessageProperty.BeginFinalizeCorrelation Method

Reference

Definition

Namespace:: System.ServiceModel.Channels

Assembly:: System.ServiceModel.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 IAsyncResult ^ BeginFinalizeCorrelation(System::ServiceModel::Channels::Message ^ message, TimeSpan timeout, AsyncCallback ^ callback, System::Object ^ state);

public IAsyncResult BeginFinalizeCorrelation (System.ServiceModel.Channels.Message message, TimeSpan timeout, AsyncCallback callback, object state);

member this.BeginFinalizeCorrelation : System.ServiceModel.Channels.Message * TimeSpan * AsyncCallback * obj -> IAsyncResult

Public Function BeginFinalizeCorrelation (message As Message, timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult

Parameters

message: Message

The message to be correlated.

timeout: TimeSpan

The interval in which correlation must be finalized or else a TimeoutException is thrown.

callback: AsyncCallback

The method to be called when the correlation calculation is completed.

state: Object

An optional application-specific object that contains information about the asynchronous operation.

Returns

IAsyncResult

A reference to the current asynchronous operation.

Remarks

This method calls OnBeginFinalizeCorrelation to construct the correlation. Applications must provide an implementation of OnBeginFinalizeCorrelation, which asynchronously performs the correlation calculation of the specified message.

To be notified when the asynchronous operation is complete, call EndFinalizeCorrelation from the callback method. If EndFinalizeCorrelation is called before the asynchronous operation is complete, it blocks until the operation completes. If the operation does not complete within the specified time-out interval a TimeoutException is thrown.

This method is an asynchronous version of FinalizeCorrelation using the IAsyncResult asynchronous design pattern. For more information, see Asynchronous Programming Overview.

Applies to