ComponentSpace ICMP Class Library Reference

EchoClient.BeginEcho Method (EchoMessage, Object, AsyncCallback)

Initiates an asynchronous echo operation that has a specified state object. This overload receives notification, through a callback, of the identity of the event handler for this operation.

[Visual Basic]
Overloads Public Function BeginEcho( _
   ByVal echoMessage As EchoMessage, _
   ByVal stateObject As Object, _
   ByVal asyncCallback As AsyncCallback _
) As IAsyncResult
[C#]
public IAsyncResult BeginEcho(
   EchoMessage echoMessage,
   object stateObject,
   AsyncCallback asyncCallback
);

Parameters

echoMessage
The echo message.
stateObject
A state object, specified by the application, that contains information associated with the asynchronous operation.
asyncCallback
The AsyncCallback that will receive the notification of the asynchronous operation completion.

Return Value

The IAsyncResult that identifies the posted asynchronous request.

Remarks

When you use this overload, the callback specified in the callback parameter is invoked directly when the echo operation has completed; the EchoCompleted event is not raised. The other overloads of BeginEcho rely on this component to raise the EchoCompleted event.

To use BeginEcho, define an asynchronous callback method. BeginEcho initiates an asynchronous echo operation; the EchoClient is notified, through a call to the callback method, when the echo operation is completed. The EchoClient can then access the echo status by calling EndEcho.

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.

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

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

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

The IAsyncResult that BeginEcho 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 EndEcho 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 BeginEcho 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

EchoClient Class | ComponentSpace.Icmp Namespace | EchoClient.BeginEcho Overload List