An abstract client-side network interface class for services in Kanzi Connect network. More...

#include <abstract_interface_client.hpp>

Inheritance diagram for kanzi::connect::AbstractInterfaceClient:

Public Types
typedef function< void(bool)>	ServiceReachableCallback
	Callback to inform whether service at server is available or not.

Public Member Functions
	AbstractInterfaceClient (RPCCallStore &callStore)
	Constructor.

AbstractSessionSharedPtr	acquireAbstractSession (MessageDispatcher *dispatcher)
	Acquires a session for this interface.

virtual string	getIdentifier () const =0
	Returns the type id of the interface.

shared_ptr< p2p::RoutingRules >	getRoutingRules ()
	Retrieve routing rules for this particular client.

AbstractSessionSharedPtr	getSession (int sessionId)
	Returns session by id.

bool	isSessionRunning (AbstractSessionSharedPtr session) const
	Check if the given session is running or not.

void	notifyServiceReachable (bool reachable)
	Invoked to notify clients whether specific service is reachable or not.

virtual void	receive (const MessagePackage &message)
	Pass a message package to this interface, resolves proper session and makes it receive the package.

virtual void	registerRemoteInterface (MessageTranslator *translator)
	Registers this interface to given message translator.

void	releaseAbstractSession (AbstractSessionSharedPtr session)
	Releases given session from this interface.

bool	serviceReachable () const
	Is service currently known to be reachable.

void	setClient (ClientSharedPtr client)
	Stores the client this interface is bound to.

void	setServiceReachableCallback (ServiceReachableCallback callback)
	Registers service reachable callback.

void	setSessionRunning (AbstractSessionSharedPtr session)
	Set the given session to running state.

void	setSessionStopped (AbstractSessionSharedPtr session)
	Set the given session to stopped state.

void	stopAllSessions ()
	Ends all sessions since maybe the service itself has disappeared.

void	terminateAllSessions ()
	Terminates all ongoing sessions.

virtual	~AbstractInterfaceClient ()
	Destructor.

Protected Member Functions
virtual AbstractSessionSharedPtr	onAcquireSession (int sessionId, MessageDispatcher *dispatcher)=0
	Function that allows derived classes to create their type-specific session instance.

virtual void	onReleaseSession (AbstractSessionSharedPtr session)
	Function that allows derived classes to destroy their type-specific session instance.

Protected Attributes
RPCCallStore &	m_callStore

Detailed Description

An abstract client-side network interface class for services in Kanzi Connect network.

Member Typedef Documentation

◆ ServiceReachableCallback

typedef function<void(bool)> kanzi::connect::AbstractInterfaceClient::ServiceReachableCallback

Callback to inform whether service at server is available or not.

Constructor & Destructor Documentation

◆ AbstractInterfaceClient()

kanzi::connect::AbstractInterfaceClient::AbstractInterfaceClient ( RPCCallStore & callStore )

Constructor.

◆ ~AbstractInterfaceClient()

virtual kanzi::connect::AbstractInterfaceClient::~AbstractInterfaceClient ( )

virtual

Destructor.

Member Function Documentation

◆ acquireAbstractSession()

AbstractSessionSharedPtr kanzi::connect::AbstractInterfaceClient::acquireAbstractSession ( MessageDispatcher * dispatcher )

Acquires a session for this interface.

Parameters

dispatcher Message dispatcher that is used to deliver network messages.

Returns: Session that was created.

◆ getIdentifier()

virtual string kanzi::connect::AbstractInterfaceClient::getIdentifier ( ) const

pure virtual

Returns the type id of the interface.

This is used to identify the service in the network.

Returns: Type of the interface, as a string.

Implemented in kanzi::connect::InterfaceClient< ObserverClass, SessionClass >, and kanzi::connect::InterfaceClient< InterfaceObserver, ExternalClientSession >.

◆ getRoutingRules()

shared_ptr< p2p::RoutingRules > kanzi::connect::AbstractInterfaceClient::getRoutingRules ( )

Retrieve routing rules for this particular client.

Returns: routing defintion.

◆ getSession()

AbstractSessionSharedPtr kanzi::connect::AbstractInterfaceClient::getSession ( int sessionId )

Returns session by id.

Parameters

sessionId Id of the session.

Returns: Session that matches given id, or 0 if there was no such session.

◆ isSessionRunning()

bool kanzi::connect::AbstractInterfaceClient::isSessionRunning ( AbstractSessionSharedPtr session ) const

Check if the given session is running or not.

Parameters

session The session to check

Returns: True if the session is running

◆ notifyServiceReachable()

void kanzi::connect::AbstractInterfaceClient::notifyServiceReachable ( bool reachable )

Invoked to notify clients whether specific service is reachable or not.

◆ onAcquireSession()

virtual AbstractSessionSharedPtr kanzi::connect::AbstractInterfaceClient::onAcquireSession	(	int	sessionId,
		MessageDispatcher *	dispatcher )

protectedpure virtual

Function that allows derived classes to create their type-specific session instance.

Parameters

sessionId	Session Id of the connected client, needs to be unique for this client.
dispatcher	Message dispatcher that is used to deliver network messages.

Returns: New session instance for this type of interface.

Implemented in kanzi::connect::InterfaceClient< ObserverClass, SessionClass >, and kanzi::connect::InterfaceClient< InterfaceObserver, ExternalClientSession >.

◆ onReleaseSession()

virtual void kanzi::connect::AbstractInterfaceClient::onReleaseSession ( AbstractSessionSharedPtr session )

inlineprotectedvirtual

Function that allows derived classes to destroy their type-specific session instance.

Parameters

session Session to release.

Reimplemented in kanzi::connect::ExternalClientInterface.

◆ receive()

virtual void kanzi::connect::AbstractInterfaceClient::receive ( const MessagePackage & message )

virtual

Pass a message package to this interface, resolves proper session and makes it receive the package.

Parameters

message Message that was sent.

Reimplemented in kanzi::connect::InterfaceClient< ObserverClass, SessionClass >, and kanzi::connect::InterfaceClient< InterfaceObserver, ExternalClientSession >.

◆ registerRemoteInterface()

virtual void kanzi::connect::AbstractInterfaceClient::registerRemoteInterface ( MessageTranslator * translator )

virtual

Registers this interface to given message translator.

Parameters

translator Translator to receive the interface definition.

◆ releaseAbstractSession()

void kanzi::connect::AbstractInterfaceClient::releaseAbstractSession ( AbstractSessionSharedPtr session )

Releases given session from this interface.

Parameters

session Session to release.

◆ serviceReachable()

bool kanzi::connect::AbstractInterfaceClient::serviceReachable ( ) const

Is service currently known to be reachable.

Returns: true if service is reachable.

◆ setClient()

void kanzi::connect::AbstractInterfaceClient::setClient ( ClientSharedPtr client )

inline

Stores the client this interface is bound to.

◆ setServiceReachableCallback()

void kanzi::connect::AbstractInterfaceClient::setServiceReachableCallback ( ServiceReachableCallback callback )

Registers service reachable callback.

Parameters

callback the callback to configure.

◆ setSessionRunning()

void kanzi::connect::AbstractInterfaceClient::setSessionRunning ( AbstractSessionSharedPtr session )

Set the given session to running state.

Parameters

session The session to set

◆ setSessionStopped()

void kanzi::connect::AbstractInterfaceClient::setSessionStopped ( AbstractSessionSharedPtr session )

Set the given session to stopped state.

Parameters

session The session to set

◆ stopAllSessions()

void kanzi::connect::AbstractInterfaceClient::stopAllSessions ( )

Ends all sessions since maybe the service itself has disappeared.

◆ terminateAllSessions()

void kanzi::connect::AbstractInterfaceClient::terminateAllSessions ( )

Terminates all ongoing sessions.

Member Data Documentation

◆ m_callStore

RPCCallStore& kanzi::connect::AbstractInterfaceClient::m_callStore

protected

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

connect/interface/abstract_interface_client.hpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ServiceReachableCallback

Constructor & Destructor Documentation

◆ AbstractInterfaceClient()

◆ ~AbstractInterfaceClient()

Member Function Documentation

◆ acquireAbstractSession()

◆ getIdentifier()

◆ getRoutingRules()

◆ getSession()

◆ isSessionRunning()

◆ notifyServiceReachable()

◆ onAcquireSession()

◆ onReleaseSession()

◆ receive()

◆ registerRemoteInterface()

◆ releaseAbstractSession()

◆ serviceReachable()

◆ setClient()

◆ setServiceReachableCallback()

◆ setSessionRunning()

◆ setSessionStopped()

◆ stopAllSessions()

◆ terminateAllSessions()

Member Data Documentation

◆ m_callStore