Class CClientConnect

• Defined in File client.h

Inheritance Relationships

Base Types

• public sdv::CSdvObject (Class CSdvObject)

• public sdv::com::IClientConnect (Struct IClientConnect)

Class Documentation

class CClientConnect : public sdv::CSdvObject, public sdv::com::IClientConnect

Client object.

Public Functions

virtual bool OnInitialize() override

Initialization event, called after object configuration was loaded. Overload of sdv::CSdvObject::OnInitialize.

Returns:

Returns ‘true’ when the initialization was successful, ‘false’ when not.

virtual void OnShutdown() override

Shutdown the object. Overload of sdv::CSdvObject::OnShutdown.

virtual bool Connect() override

Connect to a remote system. Overload of IClientConnect::Connect.

Returns:

Returns whether connect was successful.

virtual bool Disconnect() override

Disconnect from a connected system. Overload of IClientConnect::Disconnect.

Returns:

Returns whether disconnect was successful.

virtual bool IsConnected() const override

State of the current connection. Overload of IClientConnect::IsConnected.

Returns:

Returns whether an active connection exists.

Returns:

The connect state.

virtual sdv::IInterfaceAccess *GetRemoteRepository() override

Get the remote repository that is available after connection. Overload of IClientConnect::GetRemoteRepository.

Remark

For main, isolated and external applications, the remote repository will be automatically linked to the local repository. Hence a requests for the repository is not needed. For all other applications, access must be explicitly acquired through this interface.

Returns:

Interface to the remote repository if a successful connection is established. The interface is valid until disconnect is called or the client connection service is terminated.