IReplyChannel.BeginWaitForRequest Method (TimeSpan, AsyncCallback, Object)

 
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.

Begins an asynchronous request operation that has a specified time out and state object associated with it.

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

IAsyncResult BeginWaitForRequest(
	TimeSpan timeout,
	AsyncCallback callback,
	object state
)

Parameters

timeout
Type: System.TimeSpan

The TimeSpan that specifies the interval of time to wait for the reception of an available request.

callback
Type: System.AsyncCallback

The AsyncCallback delegate that receives the notification of the asynchronous receive that a request operation completes.

state
Type: System.Object

An object, specified by the application, that contains state information associated with the asynchronous receive of a request operation.

Return Value

Type: System.IAsyncResult

The IAsyncResult that references the asynchronous operation to wait for a request message to arrive.

Use the synchronous WaitForRequest(TimeSpan) method when it is acceptable for the current thread to be blocked while it waits for a request message to arrive in the queue. The thread is blocked up to the specified timeout.

This method receives notification, through a callback, of the identity of the event handler for the operation. The operation is not complete until either a request message becomes available in the channel or the time out occurs.

Notes to Implementers:

The operation returns false if the specified timeout is exceeded.

The following code illustrates how to implement this method:

public IAsyncResult BeginWaitForRequest(TimeSpan timeout, AsyncCallback callback, object state)
{
    return this.InnerChannel.BeginWaitForRequest(timeout, callback, state);
}

.NET Framework
Available since 3.0
Return to top
Show: