Returns a value that indicates whether a message has arrived within a specified interval of time.
Assembly: System.ServiceModel (in System.ServiceModel.dll)
- Type: System.TimeSpan
The specifies the maximum interval of time to wait for a message to arrive before timing out.
Return ValueType: System.Boolean
true if a message has arrived before the timeout has been exceeded; otherwise false.
Calling does not result in a message being received or processed in any other way.
The 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 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 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.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.