IInputChannel.Receive Method (TimeSpan)

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

Returns the message received, if one is available. If a message is not available, blocks for a specified interval of time.

Namespace:  System.ServiceModel.Channels
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

Syntax

'Declaration
Function Receive ( _
    timeout As TimeSpan _
) As Message
Message Receive(
    TimeSpan timeout
)

Parameters

  • timeout
    Type: System.TimeSpan
    The Timespan that specifies how long the receive operation has to complete before timing out and throwing a TimeoutException.

Return Value

Type: System.ServiceModel.Channels.Message
The Message received.

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 synchronous Receive method when it is acceptable for the current thread to be blocked until it receives the request message or exceeds the interval of time specified by timeout. Use the asynchronous BeginReceive method when you want the application processing to continue without waiting for the request to be received.

The synchronous Receive operation is available with or without an explicit timeout.

If a message is not available, it blocks until one is available or until the timeout is exceeded.

Receive can be called multiple times or concurrently. Only one Receive call can complete for each message received.

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.