IInputChannel.BeginReceive Method (TimeSpan, AsyncCallback, Object)

 

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)

IAsyncResult BeginReceive(
	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.

Exception Condition
TimeoutException

The specified timeout is exceeded before the operation is completed.

ArgumentOutOfRangeException

The timeout specified is less than zero.

Use the asynchronous BeginReceive method when you want the application processing to continue without waiting for the request to be received. Use the synchronous Receive method when it is acceptable for the current thread to be blocked until the request message is received or the interval of time specified by the timeout has been exceeded. The asynchronous operation is available with or without an explicit timeout.

The operation is not complete until either a message becomes available in the channel or the time out occurs.

Notes to Implementers:

The operation throws a TimeoutException if the specified timeout is exceeded before it completes.

The following code illustrates how to implement this method:

public IAsyncResult BeginReceive(TimeSpan timeout, AsyncCallback callback, object state)
{
    ReceiveAsyncResult<TChannel> result = new ReceiveAsyncResult<TChannel>(this, timeout, callback, state);
    result.Begin();
    return result;
}

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: