• Article

IInputChannel.BeginWaitForMessage Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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)

Syntax

'Declaration
Function BeginWaitForMessage ( _
    timeout As TimeSpan, _
    callback As AsyncCallback, _
    state As Object _
) As IAsyncResult

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.
  • 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.

Exceptions

Exception Condition
TimeoutException

The specified timeout is exceeded before the operation is completed.
ArgumentOutOfRangeException

The timeout specified is less than zero.

Remarks

Use the asynchronous BeginWaitForMessage(TimeSpan, AsyncCallback, Object) method if you want 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.

Examples

The following code shows how to implement this method.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.