IInputChannel.BeginWaitForMessage 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 wait-for-a-message-to-arrive 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 BeginWaitForMessage(
	TimeSpan timeout,
	AsyncCallback callback,
	object state
)

Parameters

timeout
Type: System.TimeSpan

The TimeSpan that specifies the interval of time to wait for a message to become available.

callback
Type: System.AsyncCallback

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

state
Type: System.Object

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

Return Value

Type: System.IAsyncResult

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

Exception Condition
TimeoutException

The specified timeout is exceeded before the operation is completed.

ArgumentOutOfRangeException

The timeout specified is less than zero.

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.

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

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show: