Export (0) Print
Expand All

IInputChannel.WaitForMessage Method

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
)
boolean WaitForMessage (
	TimeSpan timeout
)
function WaitForMessage (
	timeout : TimeSpan
) : boolean
Not applicable.

Parameters

timeout

The Timespan specifies the maximum interval of time to wait for a message to arrive before timing out.

Return Value

true if a message has arrived before the timeout has been exceeded; otherwise false.

Exception typeCondition

TimeoutException

The specified timeout is exceeded before the operation is completed.

ArgumentOutOfRangeException

The timeout specified is less than zero.

Calling WaitForMessage does not result in a message being received or processed in any other way.

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

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0

Community Additions

ADD
Show:
© 2014 Microsoft