ComponentSpace Proxy Class Library Reference

IProxyClient.BeginConnect Method (String, Int32, String, String)

Initiates an asynchronous connect operation.

[Visual Basic]
Function BeginConnect( _
   ByVal serverAddress As String, _
   ByVal serverPort As Integer, _
   ByVal userName As String, _
   ByVal password As String _
) As IAsyncResult
[C#]
IAsyncResult BeginConnect(
   string serverAddress,
   int serverPort,
   string userName,
   string password
);

Parameters

serverAddress
The destination server address (eg. 66.210.153.11 or www.myserver.com).
serverPort
The destination server port number.
userName
The user ID or null.
password
The password or null.

Return Value

The IAsyncResult that identifies the posted asynchronous request.

Remarks

In asynchronous processing, you use BeginConnect to raise the ConnectCompleted event when the connect operation has completed.

To use BeginConnect, create an event handler that processes the results of the asynchronous operation and associate it with your event delegate. BeginConnect initiates an asynchronous connect operation; the ProxyClientBase is notified, through the raising of the ConnectCompleted event, when the connect operation is completed. The ProxyClientBase can then access the connect status by calling EndConnect.

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

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

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

The IAsyncResult that BeginConnect 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 EndConnect 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.

See Also

IProxyClient Interface | ComponentSpace.Proxy Namespace | IProxyClient.BeginConnect Overload List