IInputChannel.WaitForMessage Method
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Returns a value that indicates whether a message has arrived within a specified interval of time.
Namespace: System.ServiceModel.Channels
Assembly: System.ServiceModel (in System.ServiceModel.dll)
Syntax
'Declaration
Function WaitForMessage ( _
timeout As TimeSpan _
) As Boolean
bool WaitForMessage(
TimeSpan timeout
)
Parameters
- timeout
Type: System.TimeSpan
The Timespan specifies the maximum interval of time to wait for a message to arrive before timing out.
Return Value
Type: System.Boolean
true if a message has arrived before the timeout has been exceeded; otherwise false.
Exceptions
| Exception | Condition |
|---|---|
| TimeoutException | The specified timeout is exceeded before the operation is completed. |
| ArgumentOutOfRangeException | The timeout specified is less than zero. |
Remarks
Calling WaitForMessage(TimeSpan) does not result in a message being received or processed in any other way.
The WaitForMessage(TimeSpan) method exists primarily for transacted scenarios where the user wants to receive the message using a transaction. When using just Receive normally for this, the user must create the transaction and then call Receive and hope the message arrives before the transaction times out, which may not be possible.
Instead, the user can call WaitForMessage(TimeSpan) with whatever time out they want (even infinite), then when a message arrives they can open the transaction, call Receive and be confident that they can get the message back before the transaction expires.
This method is synchronous, so it blocks the current thread until a message is available or the time out occurs. Use WaitForMessage(TimeSpan) 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. If you want the application processing to continue without waiting, use the asynchronous BeginWaitForMessage(TimeSpan, AsyncCallback, Object) method.
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.