ClientBaseConnectAsync Method

Connects the client to the server asynchronously.

Namespace: GSF.Communication
Assembly: GSF.Communication (in GSF.Communication.dll) Version: 2.4.218-beta

Syntax

public virtual WaitHandle ConnectAsync()

Public Overridable Function ConnectAsync As WaitHandle

public:
virtual WaitHandle^ ConnectAsync()

abstract ConnectAsync : unit -> WaitHandle 
override ConnectAsync : unit -> WaitHandle

function ConnectAsync();

View Source

Return Value

WaitHandle
WaitHandle for the asynchronous operation.

Implements

IClientConnectAsync

Exceptions

Exception	Condition
FormatException	Server property in ConnectionString is invalid.
InvalidOperationException	Attempt is made to connect the client when it is not disconnected.

Remarks

Derived classes are expected to override this method with protocol specific connection operations. Call the base class method to obtain an operational wait handle if protocol connection operation doesn't provide one already.

Reference

ClientBase Class

GSF.Communication Namespace