ClientInterface Class Reference

Client control interface for endpoints. More...

#include <ClientInterface.hpp>

Public Member Functions
virtual void	SetLinkPath (const std::string &link_path)=0
	Set the path string (with prefix) to be used for the link.
virtual const std::string &	GetLinkPath () const noexcept=0
	Get the path string (with prefix) to use for the link.
virtual void	StartLink ()=0
	Initiate link (linkage) with client.
virtual void	StopLink ()=0
	Break linkage with the currently linked (linked) client.
virtual bool	IsLinked () const noexcept=0
	Check whether the link (linkage) is currently established.
virtual std::shared_future< std::string >	GetLinkStatus () const =0
	Get shared_future which returns the status of establishment of the link (linkage).
virtual bool	IsConnectedToCloud () const noexcept=0
	Check if it is connected to the cloud.
virtual std::shared_future< void >	GetCloudConnectionStatus () const =0
	Get shared_future which returns the status of connection to the cloud.
virtual std::unique_ptr< video::FactoryInterface >	CreateVideoFactory ()=0
	Generate a VideoFactory associated with this Client.
virtual std::unique_ptr< audio::FactoryInterface >	CreateAudioFactory ()=0
	Create an AudioFactory associated with this Client.
virtual std::unique_ptr< serial::FactoryInterface >	CreateSerialFactory ()=0
	Create a SerialFactory associated with this Client.
virtual std::unique_ptr< control::FactoryInterface >	CreateControlFactory ()=0
	Create a ControlFactory associated with this Client.

Detailed Description

Client control interface for endpoints.

Member Function Documentation

GetCloudConnectionStatus()

virtual std::shared_future< void > ClientInterface::GetCloudConnectionStatus ( ) const

pure virtual

Get shared_future which returns the status of connection to the cloud.

Note

If already connected, return an object in the ready state.

GetLinkPath()

virtual const std::string & ClientInterface::GetLinkPath ( ) const

pure virtualnoexcept

Get the path string (with prefix) to use for the link.

Note

The type of path depends on the platform.

GetLinkStatus()

virtual std::shared_future< std::string > ClientInterface::GetLinkStatus ( ) const

pure virtual

Get shared_future which returns the status of establishment of the link (linkage).

Note

If already established, return an object in the ready state.

Returns

shared_future object that returns the path when the link (linkage) is established.

IsConnectedToCloud()

virtual bool ClientInterface::IsConnectedToCloud ( ) const

pure virtualnoexcept

Check if it is connected to the cloud.

Return values

true	Connected to the cloud.
false	Not linked or not connected to cloud

IsLinked()

virtual bool ClientInterface::IsLinked ( ) const

pure virtualnoexcept

Check whether the link (linkage) is currently established.

Return values

true
true	Linked
false	Not linked

SetLinkPath()

virtual void ClientInterface::SetLinkPath ( const std::string &  link_path )

pure virtual

Set the path string (with prefix) to be used for the link.

Note

The type of path depends on the platform.

Parameters

link_path

path string

StartLink()

virtual void ClientInterface::StartLink ( )

pure virtual

Initiate link (linkage) with client.

Note

Linking is done asynchronously, and the callback is notified when the linkage is started.

---

The documentation for this class was generated from the following file:

• /Users/manabutogawa/Downloads/libzep_doxygen_src.20230515/include/zep-en/ClientInterface.hpp