IInputChannel.BeginReceive Method

Source:

IInputChannel.cs

Source:

IInputChannel.cs

Source:

IInputChannel.cs

public:
 IAsyncResult ^ BeginReceive(AsyncCallback ^ callback, System::Object ^ state);

public IAsyncResult BeginReceive (AsyncCallback callback, object state);

abstract member BeginReceive : AsyncCallback * obj -> IAsyncResult

Public Function BeginReceive (callback As AsyncCallback, state As Object) As IAsyncResult

Parameters

Returns

The IAsyncResult that references the asynchronous message reception.

Examples

The following code illustrates how to implement this method:

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

Remarks

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.

Source:

IInputChannel.cs

Source:

IInputChannel.cs

Source:

IInputChannel.cs

public:
 IAsyncResult ^ BeginReceive(TimeSpan timeout, AsyncCallback ^ callback, System::Object ^ state);

public IAsyncResult BeginReceive (TimeSpan timeout, AsyncCallback callback, object state);

abstract member BeginReceive : TimeSpan * AsyncCallback * obj -> IAsyncResult

Public Function BeginReceive (timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult

Parameters

Returns

The IAsyncResult that references the asynchronous receive operation.

Exceptions

Examples

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;
}

Remarks

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.