ComponentSpace DNS Class Library Reference

DnsClient.BeginReceive Method (Object)

Initiates an asynchronous receive operation that has a specified state object.

[Visual Basic]
Overloads Public Function BeginReceive( _
   ByVal stateObject As Object _
) As IAsyncResult
[C#]
public IAsyncResult BeginReceive(
   object stateObject
);

Parameters

stateObject
A state object, specified by the application, that contains information associated with the asynchronous operation.

Return Value

The IAsyncResult that identifies the posted asynchronous request.

Remarks

In asynchronous processing, you use BeginReceive to raise the ReceiveCompleted event when the receive operation has completed.

Use this overload to associate information with the operation that will be preserved throughout the operation's lifetime. The event handler can detect this information by looking at the AsyncState of the IAsyncResult that is associated with the operation.

To use BeginReceive, create an event handler that processes the results of the asynchronous operation and associate it with your event delegate. BeginReceive initiates an asynchronous receive operation; the DnsClient is notified, through the raising of the ReceiveCompleted event, when the receive operation is completed. The DnsClient can then access the receive status by calling EndReceive.

Note: The BeginReceive method returns immediately, but the asynchronous operation is not completed until the event handler is called.

Because BeginReceive is asynchronous, you can call it to receive the receive status without blocking the current thread of execution. To synchronously receive, use the Receive method.

Once an asynchronous operation completes, you can call BeginReceive again in the event handler to keep receiving notifications.

The IAsyncResult that BeginReceive returns identifies the asynchronous operation that the method call started. You can use this IAsyncResult throughout the lifetime of the operation, although you generally do not use it until EndReceive is called. However, if you start several asynchronous operations, you can place their IAsyncResult values in an array and specify whether to wait for all operations or any operation to complete. In this case, you use the AsyncWaitHandle property of the IAsyncResult to identify the completed operation.

The state object associates state information with the operation. For example, if you call BeginReceive multiple times to initiate multiple operations, you can identify each operation through a separate state object that you define.

You can also use the state object to pass information across process threads. If a thread is started but the callback is on a different thread in an asynchronous scenario, the state object is marshaled and passed back along with information from the event.

See Also

DnsClient Class | ComponentSpace.Dns Namespace | DnsClient.BeginReceive Overload List