IInputChannel.BeginTryReceive Method
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Begins an asynchronous operation to receive a message that has a specified time out and state object associated with it.
Namespace: System.ServiceModel.Channels
Assembly: System.ServiceModel (in System.ServiceModel.dll)
Syntax
'Declaration
Function BeginTryReceive ( _
timeout As TimeSpan, _
callback As AsyncCallback, _
state As Object _
) As IAsyncResult
IAsyncResult BeginTryReceive(
TimeSpan timeout,
AsyncCallback callback,
Object state
)
Parameters
- timeout
Type: System.TimeSpan
The Timespan that specifies the interval of time to wait for a message to become available.
- callback
Type: System.AsyncCallback
The AsyncCallback delegate that receives the notification of the asynchronous operation completion.
- state
Type: System.Object
An object, specified by the application, that contains state information associated with the asynchronous operation.
Return Value
Type: System.IAsyncResult
The IAsyncResult that references the asynchronous receive operation.
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 asynchronous BeginTryReceive(TimeSpan, AsyncCallback, Object) method when you want the application processing to continue without waiting. Use the synchronous TryReceive(TimeSpan, Message%) method when it is acceptable for the current thread to be blocked while it replies to the request message or until the timeout interval is exceeded.
The operation is not complete until either a message becomes available in the channel or the timeout occurs.
If you are going to handle timeouts and not just re-throw or wrap the TimeoutException, then you should call BeginTryReceive(TimeSpan, AsyncCallback, Object) instead of BeginReceive.
If you are not going to treat timeouts specially then just call BeginReceive, otherwise you lose error information.
Notes to Implementers
The operation returns false from EndTryReceive(IAsyncResult, Message%) if the specified timeout is exceeded.
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.