Struct IClientConnect#

Inheritance Relationships#

Derived Type#

Struct Documentation#

struct IClientConnect#

Connect to a remote system. Provided by the Connection service.

This interface is exposed by the connection client service. The configuration is provided during instantiation of the object and is of the form: 

# Provider to use for the connection
[Provider]
Name = ""

# Additional channel information for the client
[IpcChannel]
xyz = ""

For example for shared memory: 

[Provider]
Name = "DefaultSharedMemory"
[IpcChannel]
Name = "LISTENER_1234"

Subclassed by CClientConnect

Public Functions

virtual bool Connect() = 0#

Connect to a remote system.

Returns:

Returns whether connect was successful.

virtual bool Disconnect() = 0#

Disconnect from a connected system.

Returns:

Returns whether disconnect was successful.

virtual bool IsConnected() const = 0#

State of the current connection.

Returns:

Returns whether an active connection exists.

virtual IInterfaceAccess *GetRemoteRepository() = 0#

Get the remote repository that is available after connection.

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.

boolean Connect()

Connect to a remote system.

Returns:

Returns whether connect was successful.

boolean Disconnect()

Disconnect from a connected system.

Returns:

Returns whether disconnect was successful.

boolean IsConnected() const

State of the current connection.

Returns:

Returns whether an active connection exists.

IInterfaceAccess GetRemoteRepository()

Get the remote repository that is available after connection.

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.

Public Static Attributes

static constexpr ::sdv::interface_id _id = 0x6A220464A7E5E037#

Interface ID.