An abstract class that acts as an interface to underlying network transport layer. More...

#include <connection_adapter_client.hpp>

Inheritance diagram for kanzi::connect::ClientConnectionAdapter:

Classes
class	Observer
	Observer class that allows to receive notifications from the connection adapter. More...

Public Types
typedef map< string, string >	Parameters
	Container type for parameters.

Public Member Functions
virtual void	aboutToStop ()
	Invoked when the adapter should stop. Called before the object will be destroyed.

void	addObserver (Observer *observer)
	Adds observer to receive notification from this adapter.

	ClientConnectionAdapter ()
	Constructor.

virtual bool	configure (const Parameters &parameters)
	Allows to configure the adapter with adapter-specific settings (key-value pairs).

virtual bool	connect ()=0
	Connects adapter to server.

virtual void	disconnect ()=0
	Disconnects adapter from server.

virtual shared_ptr< MessageTranslator >	getNetworkTranslator (MessagePackage::SerializationFormat format=MessagePackage::SerializationFormatBinary)

virtual string	getParameter (const string &parameter)
	Adapter can expose it's parameters using key-value pairs.

virtual string	getState (const string &parameter)=0
	Adapter can expose it's internal state by using key-value pairs.

virtual string	getType () const =0
	Returns type of the adapter, this needs to be unique for every adapter.

virtual void	interrupt ()=0
	Signals to stop waiting for events.

void	removeObserver (Observer *observer)
	Removes observer from this adapter.

virtual void	send (const vector< char > &data)=0
	Sends data to network.

virtual void	setClient (Client *client)
	Allows to set a pointer to the Client instance for this adapter.

virtual int	wait ()=0
	Starts waiting event(s) from network, can block to preserve CPU.

virtual void	work (int status)=0
	Once wait is completed, this method is called for the adapter to process the received network events.

virtual	~ClientConnectionAdapter ()
	Destructor.

Protected Member Functions
void	notifyConnected ()
	Allows derived class to invoke connection notification to all observers.

void	notifyDisconnected ()
	Allows derived class to invoke disconnect notification to all observers.

void	notifyReceive (const vector< char > &data)
	Allows derived class to invoke data received notification to all observers.

Static Protected Member Functions
static string	getConfigurationParameterString (const Parameters &parameters, const string &parameter)
	Get single single string type configuration parameter. Returns empty string for missing parameter.

Detailed Description

An abstract class that acts as an interface to underlying network transport layer.

This class interface provides functionality to connect to server and transmit & receive data.

Member Typedef Documentation

◆ Parameters

typedef map<string, string> kanzi::connect::ClientConnectionAdapter::Parameters

Container type for parameters.

Constructor & Destructor Documentation

◆ ClientConnectionAdapter()

kanzi::connect::ClientConnectionAdapter::ClientConnectionAdapter ( )

inline

Constructor.

◆ ~ClientConnectionAdapter()

virtual kanzi::connect::ClientConnectionAdapter::~ClientConnectionAdapter ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ aboutToStop()

virtual void kanzi::connect::ClientConnectionAdapter::aboutToStop ( )

inlinevirtual

Invoked when the adapter should stop. Called before the object will be destroyed.

◆ addObserver()

void kanzi::connect::ClientConnectionAdapter::addObserver ( Observer * observer )

Adds observer to receive notification from this adapter.

Parameters

observer Observer to add.

◆ configure()

virtual bool kanzi::connect::ClientConnectionAdapter::configure ( const Parameters & parameters )

inlinevirtual

Allows to configure the adapter with adapter-specific settings (key-value pairs).

Parameters

parameters Configuration parameters, as string-based key value pairs.

Returns: True if the adapter was successfully configured, otherwise false.

Reimplemented in kanzi::connect::ClientSocketConnectionAdapter.

◆ connect()

virtual bool kanzi::connect::ClientConnectionAdapter::connect ( )

pure virtual

Connects adapter to server.

Returns: True if connection attempt is successful.

Implemented in kanzi::connect::ClientSocketConnectionAdapter.

◆ disconnect()

virtual void kanzi::connect::ClientConnectionAdapter::disconnect ( )

pure virtual

Disconnects adapter from server.

Implemented in kanzi::connect::ClientSocketConnectionAdapter.

◆ getConfigurationParameterString()

static string kanzi::connect::ClientConnectionAdapter::getConfigurationParameterString	(	const Parameters &	parameters,
		const string &	parameter )

staticprotected

Get single single string type configuration parameter. Returns empty string for missing parameter.

◆ getNetworkTranslator()

virtual shared_ptr< MessageTranslator > kanzi::connect::ClientConnectionAdapter::getNetworkTranslator ( MessagePackage::SerializationFormat format = MessagePackage::SerializationFormatBinary )

virtual

◆ getParameter()

virtual string kanzi::connect::ClientConnectionAdapter::getParameter ( const string & parameter )

inlinevirtual

Adapter can expose it's parameters using key-value pairs.

This function allows to retrieve a parameter value that was used to configure the adapter.

Parameters

parameter Key argument for parameter query.

Returns: Value for a given key that represents configuration parameter.

◆ getState()

virtual string kanzi::connect::ClientConnectionAdapter::getState ( const string & parameter )

pure virtual

Adapter can expose it's internal state by using key-value pairs.

This function allows to retrieve a state value from adapter for a given key.

Parameters

parameter Key argument for state query.

Returns: Value for a given key that represents a state of the given parameter.

Implemented in kanzi::connect::ClientSocketConnectionAdapter.

◆ getType()

virtual string kanzi::connect::ClientConnectionAdapter::getType ( ) const

pure virtual

Returns type of the adapter, this needs to be unique for every adapter.

Returns: Adapter type as string.

◆ interrupt()

virtual void kanzi::connect::ClientConnectionAdapter::interrupt ( )

pure virtual

Signals to stop waiting for events.

Implemented in kanzi::connect::ClientSocketConnectionAdapter.

◆ notifyConnected()

void kanzi::connect::ClientConnectionAdapter::notifyConnected ( )

protected

Allows derived class to invoke connection notification to all observers.

◆ notifyDisconnected()

void kanzi::connect::ClientConnectionAdapter::notifyDisconnected ( )

protected

Allows derived class to invoke disconnect notification to all observers.

◆ notifyReceive()

void kanzi::connect::ClientConnectionAdapter::notifyReceive ( const vector< char > & data )

protected

Allows derived class to invoke data received notification to all observers.

◆ removeObserver()

void kanzi::connect::ClientConnectionAdapter::removeObserver ( Observer * observer )

Removes observer from this adapter.

Parameters

observer Observer to remove.

◆ send()

virtual void kanzi::connect::ClientConnectionAdapter::send ( const vector< char > & data )

pure virtual

Sends data to network.

Parameters

data	Data to send.

◆ setClient()

virtual void kanzi::connect::ClientConnectionAdapter::setClient ( Client * client )

inlinevirtual

Allows to set a pointer to the Client instance for this adapter.

This enables adapters, to access service functionality provided by the Client instance.

Parameters

client Client instance associated with this adapters.

◆ wait()

virtual int kanzi::connect::ClientConnectionAdapter::wait ( )

pure virtual

Starts waiting event(s) from network, can block to preserve CPU.

Returns: Must return <0 in case unrecoverable error occured and method should not be called anymore. >= 0 in case processing should continue. In this case returned value is passed to work(..) routine.

Implemented in kanzi::connect::ClientSocketConnectionAdapter.

◆ work()

virtual void kanzi::connect::ClientConnectionAdapter::work ( int status )

pure virtual

Once wait is completed, this method is called for the adapter to process the received network events.

Parameters

status the status (>=0) value returned by the wait() routine called earlier.

Implemented in kanzi::connect::ClientSocketConnectionAdapter.

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

connect/connection/connection_adapter_client.hpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ Parameters

Constructor & Destructor Documentation

◆ ClientConnectionAdapter()

◆ ~ClientConnectionAdapter()

Member Function Documentation

◆ aboutToStop()

◆ addObserver()

◆ configure()

◆ connect()

◆ disconnect()

◆ getConfigurationParameterString()

◆ getNetworkTranslator()

◆ getParameter()

◆ getState()

◆ getType()

◆ interrupt()

◆ notifyConnected()

◆ notifyDisconnected()

◆ notifyReceive()

◆ removeObserver()

◆ send()

◆ setClient()

◆ wait()

◆ work()