IInputChannel.BeginWaitForMessage(TimeSpan, AsyncCallback, Object) Method

Definition

Namespace:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.0.0

Source:

IInputChannel.cs

Begins an asynchronous wait-for-a-message-to-arrive operation that has a specified time out and state object associated with it.

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

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

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

Public Function BeginWaitForMessage (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 a message to become available.

callback

AsyncCallback

The AsyncCallback delegate that receives the notification of the asynchronous operation completion.

state

Object

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

Returns

IAsyncResult

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

Exceptions

TimeoutException

The specified timeout is exceeded before the operation is completed.

ArgumentOutOfRangeException

The timeout specified is less than zero.

Examples

The following code illustrates how to implement this method:

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

Remarks

Use the asynchronous BeginWaitForMessage(TimeSpan, AsyncCallback, Object) method if you need the application processing to continue without waiting for the message to arrive. Use the synchronous WaitForMessage(TimeSpan) method when it is acceptable for the current thread to be blocked while it waits for a 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 message becomes available in the channel or the time out occurs.

Notes to Implementers

The operation returns false if the specified timeout is exceeded, not a timeout exception.