Templated abstract base class for network interfaces. More...

#include <abstract_interface_client.hpp>

Inheritance diagram for kanzi::connect::InterfaceClient< ObserverClass, SessionClass >:

Public Types
typedef map< AbstractSessionSharedPtr, ObserverClass * >	ObserverContainer
	Type definition for observer container.

Public Types inherited from kanzi::connect::AbstractInterfaceClient
typedef function< void(bool)>	ServiceReachableCallback
	Callback to inform whether service at server is available or not.

Public Member Functions
AbstractSessionSharedPtr	acquireSession (MessageDispatcher *dispatcher)
	Acquire session in to this interface.

void	addObserver (AbstractSessionSharedPtr session, ObserverClass *observer)
	Add observer in to this interface for given session.

RPCCallStore &	getCallStore ()
	Retrieve RPC call store that is used to manage pending RPC calls.

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

ObserverClass *	getObserver (AbstractSessionSharedPtr session)
	Retrieve observer for given session.

	InterfaceClient (const string &identifier, RPCCallStore &callstore)

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

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

void	releaseSession (AbstractSessionSharedPtr session)
	Release session that is connected to this interface.

void	removeObserver (AbstractSessionSharedPtr session)
	Remove observer from a given session.

Public Member Functions inherited from kanzi::connect::AbstractInterfaceClient
	AbstractInterfaceClient (RPCCallStore &callStore)
	Constructor.

AbstractSessionSharedPtr	acquireAbstractSession (MessageDispatcher *dispatcher)
	Acquires a session for this 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	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 Attributes
string	m_identifier

Protected Attributes inherited from kanzi::connect::AbstractInterfaceClient
RPCCallStore &	m_callStore

Additional Inherited Members
Protected Member Functions inherited from kanzi::connect::AbstractInterfaceClient
virtual void	onReleaseSession (AbstractSessionSharedPtr session)
	Function that allows derived classes to destroy their type-specific session instance.

Detailed Description

template<class ObserverClass, class SessionClass>
class kanzi::connect::InterfaceClient< ObserverClass, SessionClass >

Templated abstract base class for network interfaces.

Enforces type safety in interface and implements support for observers.

Member Typedef Documentation

◆ ObserverContainer

template<class ObserverClass , class SessionClass >

typedef map<AbstractSessionSharedPtr, ObserverClass*> kanzi::connect::InterfaceClient< ObserverClass, SessionClass >::ObserverContainer

Type definition for observer container.

Constructor & Destructor Documentation

◆ InterfaceClient()

template<class ObserverClass , class SessionClass >

kanzi::connect::InterfaceClient< ObserverClass, SessionClass >::InterfaceClient	(	const string &	identifier,
		RPCCallStore &	callstore )

inline

Member Function Documentation

◆ acquireSession()

template<class ObserverClass , class SessionClass >

AbstractSessionSharedPtr kanzi::connect::InterfaceClient< ObserverClass, SessionClass >::acquireSession ( MessageDispatcher * dispatcher )

inline

Acquire session in to this interface.

Parameters

dispatcher Message dispatcher that is used to deliver network messages.

Returns: New session instance for this interface type.

◆ addObserver()

template<class ObserverClass , class SessionClass >

void kanzi::connect::InterfaceClient< ObserverClass, SessionClass >::addObserver	(	AbstractSessionSharedPtr	session,
		ObserverClass *	observer )

inline

Add observer in to this interface for given session.

Parameters

session	Session to observe.
observer	Observer to receive notifications.

◆ getCallStore()

template<class ObserverClass , class SessionClass >

RPCCallStore & kanzi::connect::InterfaceClient< ObserverClass, SessionClass >::getCallStore ( )

inline

Retrieve RPC call store that is used to manage pending RPC calls.

Returns: reference to RPC callstore implementation.

◆ getIdentifier()

template<class ObserverClass , class SessionClass >

virtual string kanzi::connect::InterfaceClient< ObserverClass, SessionClass >::getIdentifier ( ) const

inlinevirtual

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.

Implements kanzi::connect::AbstractInterfaceClient.

◆ getObserver()

template<class ObserverClass , class SessionClass >

ObserverClass * kanzi::connect::InterfaceClient< ObserverClass, SessionClass >::getObserver ( AbstractSessionSharedPtr session )

inline

Retrieve observer for given session.

Parameters

session Session being observed.

Returns: Observer that is connected to session, or null if there is no such observer.

◆ onAcquireSession()

template<class ObserverClass , class SessionClass >

virtual AbstractSessionSharedPtr kanzi::connect::InterfaceClient< ObserverClass, SessionClass >::onAcquireSession	(	int	sessionId,
		MessageDispatcher *	dispatcher )

inlinevirtual

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.

Implements kanzi::connect::AbstractInterfaceClient.

◆ receive()

template<class ObserverClass , class SessionClass >

virtual void kanzi::connect::InterfaceClient< ObserverClass, SessionClass >::receive ( const MessagePackage & message )

inlinevirtual

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

Parameters

message Message that was sent.

Reimplemented from kanzi::connect::AbstractInterfaceClient.

◆ releaseSession()

template<class ObserverClass , class SessionClass >

void kanzi::connect::InterfaceClient< ObserverClass, SessionClass >::releaseSession ( AbstractSessionSharedPtr session )

inline

Release session that is connected to this interface.

Parameters

session Session to release.

◆ removeObserver()

template<class ObserverClass , class SessionClass >

void kanzi::connect::InterfaceClient< ObserverClass, SessionClass >::removeObserver ( AbstractSessionSharedPtr session )

inline

Remove observer from a given session.

Parameters

session Session to remove observer from.

Member Data Documentation

◆ m_identifier

template<class ObserverClass , class SessionClass >

string kanzi::connect::InterfaceClient< ObserverClass, SessionClass >::m_identifier

protected

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

connect/interface/abstract_interface_client.hpp

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ObserverContainer

Constructor & Destructor Documentation

◆ InterfaceClient()

Member Function Documentation

◆ acquireSession()

◆ addObserver()

◆ getCallStore()

◆ getIdentifier()

◆ getObserver()

◆ onAcquireSession()

◆ receive()

◆ releaseSession()

◆ removeObserver()

Member Data Documentation

◆ m_identifier