Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
BeginReceive Method (AsyncCallback, Object)

IInputChannel.BeginReceive Method (AsyncCallback, Object)

Begins an asynchronous operation to receive a message that has a state object associated with it.

Namespace:  System.ServiceModel.Channels
Assemblies:   System.ServiceModel (in System.ServiceModel.dll)
  System.ServiceModel.Primitives (in System.ServiceModel.Primitives.dll)

IAsyncResult BeginReceive(
	AsyncCallback callback,
	Object state
)

Parameters

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 message reception.

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.

This method receives notification, through a callback, of the identity of the event handler for the operation. The operation is not complete until a message becomes available in the channel.

The following code illustrates how to implement this method:

public IAsyncResult BeginReceive(AsyncCallback callback, object state)
{
    return BeginReceive(DefaultReceiveTimeout, callback, state);
}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Portable Class Library

Supported in: Portable Class Library
Show:
© 2015 Microsoft