IInputChannel.WaitForMessage Method (TimeSpan)

 

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)

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.

Exception Condition
TimeoutException

The specified timeout is exceeded before the operation is completed.

ArgumentOutOfRangeException

The timeout specified is less than zero.

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

The following code illustrates how to implement this method:

public bool WaitForMessage(TimeSpan timeout)
{
    return this.InnerChannel.WaitForMessage(timeout);
}

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: