IReplyChannel.BeginWaitForRequest(TimeSpan, AsyncCallback, Object) Method

Definition

Namespace:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v6.2.0

Source:

IReplyChannel.cs

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

public:
 IAsyncResult ^ BeginWaitForRequest(TimeSpan timeout, AsyncCallback ^ callback, System::Object ^ state);

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

abstract member BeginWaitForRequest : TimeSpan * AsyncCallback * obj -> IAsyncResult

Public Function BeginWaitForRequest (timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult

Parameters

timeout

TimeSpan

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

callback

AsyncCallback

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

state

Object

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

Returns

IAsyncResult

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

Examples

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);
}

Remarks

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.