CorrelationCallbackMessageProperty.BeginFinalizeCorrelation Method (Message, TimeSpan, AsyncCallback, Object)

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

public IAsyncResult BeginFinalizeCorrelation(
	Message message,
	TimeSpan timeout,
	AsyncCallback callback,
	object state
)

Parameters

message
Type: System.ServiceModel.Channels.Message

The message to be correlated.

timeout
Type: System.TimeSpan

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

callback
Type: System.AsyncCallback

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

state
Type: System.Object

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

Return Value

Type: System.IAsyncResult

A reference to the current asynchronous operation.

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, seeAsynchronous Programming Overview.

.NET Framework
Available since 4.0
Return to top
Show: