A class that implements connection adapter for TCP-IP transport type. More...

#include <connection_adapter_socket_client.hpp>

Inheritance diagram for kanzi::connect::ClientSocketConnectionAdapter:

Public Member Functions
	ClientSocketConnectionAdapter (int socketType)
	Constructor.

virtual bool	configure (const ClientConnectionAdapter::Parameters &parameters)
	See ConnectionAdapter::configure.

virtual bool	connect ()
	See ConnectionAdapter::connect.

virtual void	disconnect ()
	See ConnectionAdapter::disconnect.

virtual string	getState (const string &parameter)
	See ConnectionAdapter::getState.

virtual void	interrupt ()
	See ConnectionAdapter::interrupt.

virtual int	wait ()
	See ConnectionAdapter::wait.

virtual void	work (int status)
	See ConnectionAdapter::work.

virtual	~ClientSocketConnectionAdapter ()
	Destructor.

Public Member Functions inherited from kanzi::connect::ClientConnectionAdapter
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 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	getType () const =0
	Returns type of the adapter, this needs to be unique for every adapter.

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	~ClientConnectionAdapter ()
	Destructor.

Static Public Attributes
static const string	PARAMETER_HOST_IP
	Configuration parameter for server ip address.

static const string	PARAMETER_HOST_PORT
	Configuration parameter for server port.

static const string	STATE_IP
	State parameter to read adapter ip address back.

static const string	STATE_PORT
	State parameter to read adapter port back.

Protected Member Functions
void	clearTxQueue ()
	Clears the transmit queue.

void	discardFromTxQueue (size_t bytes)
	Discards data (after being sent) from tx queue.

virtual bool	hasPendingTxSocketData ()
	Determine whether the client implementation has pending data to write.

bool	queueTxData (const vector< char > &data, size_t maxQueueDepth, size_t position=0)
	Tries to queue given buffer to tx queue.

virtual void	read ()=0
	Do the reading from socket.

virtual void	sendPendingTxSocketData ()
	Write pending data into the socket.

Protected Member Functions inherited from kanzi::connect::ClientConnectionAdapter
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.

Protected Attributes
recursive_mutex	m_mutex

int	m_port
	Configured server port.

string	m_server
	Configured server address.

::fd_set *	m_set
	Activated sockets during wait.

int	m_signal [2]

Socket *	m_socket
	Socket used by this adapter.

int	m_socketType
	Socket type.

vector< char >	m_txBuffer

int	m_workResult
	Result of wait is stored here.

::fd_set *	m_writeSet

Additional Inherited Members
Public Types inherited from kanzi::connect::ClientConnectionAdapter
typedef map< string, string >	Parameters
	Container type for parameters.

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

Detailed Description

A class that implements connection adapter for TCP-IP transport type.

Constructor & Destructor Documentation

◆ ClientSocketConnectionAdapter()

kanzi::connect::ClientSocketConnectionAdapter::ClientSocketConnectionAdapter ( int socketType )

Constructor.

Parameters

socketType Sets the type of the socket to be created (either streaming or datagram).

◆ ~ClientSocketConnectionAdapter()

virtual kanzi::connect::ClientSocketConnectionAdapter::~ClientSocketConnectionAdapter ( )

virtual

Destructor.

Member Function Documentation

◆ clearTxQueue()

void kanzi::connect::ClientSocketConnectionAdapter::clearTxQueue ( )

protected

Clears the transmit queue.

◆ configure()

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

virtual

See ConnectionAdapter::configure.

Reimplemented from kanzi::connect::ClientConnectionAdapter.

◆ connect()

virtual bool kanzi::connect::ClientSocketConnectionAdapter::connect ( )

virtual

See ConnectionAdapter::connect.

Implements kanzi::connect::ClientConnectionAdapter.

◆ discardFromTxQueue()

void kanzi::connect::ClientSocketConnectionAdapter::discardFromTxQueue ( size_t bytes )

protected

Discards data (after being sent) from tx queue.

Parameters

bytes amount of data to discard.

◆ disconnect()

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

virtual

See ConnectionAdapter::disconnect.

Implements kanzi::connect::ClientConnectionAdapter.

◆ getState()

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

virtual

See ConnectionAdapter::getState.

Implements kanzi::connect::ClientConnectionAdapter.

◆ hasPendingTxSocketData()

virtual bool kanzi::connect::ClientSocketConnectionAdapter::hasPendingTxSocketData ( )

inlineprotectedvirtual

Determine whether the client implementation has pending data to write.

Returns: true if there is pending data to write and socket should be listened for write availability also.

◆ interrupt()

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

virtual

See ConnectionAdapter::interrupt.

Implements kanzi::connect::ClientConnectionAdapter.

◆ queueTxData()

bool kanzi::connect::ClientSocketConnectionAdapter::queueTxData	(	const vector< char > &	data,
		size_t	maxQueueDepth,
		size_t	position = 0 )

protected

Tries to queue given buffer to tx queue.

Parameters

data	the data to queue
maxQueueDepth	the maximum allowed depth for the queue
position	from the data vector, at which position to start inserting data to queue. optional.

Returns: true if queued successfully, false if not fit or other problems faced.

◆ read()

virtual void kanzi::connect::ClientSocketConnectionAdapter::read ( )

protectedpure virtual

Do the reading from socket.

◆ sendPendingTxSocketData()

virtual void kanzi::connect::ClientSocketConnectionAdapter::sendPendingTxSocketData ( )

inlineprotectedvirtual

Write pending data into the socket.

◆ wait()

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

virtual

See ConnectionAdapter::wait.

Implements kanzi::connect::ClientConnectionAdapter.

◆ work()

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

virtual

See ConnectionAdapter::work.

Implements kanzi::connect::ClientConnectionAdapter.

Member Data Documentation

◆ m_mutex

recursive_mutex kanzi::connect::ClientSocketConnectionAdapter::m_mutex

protected

◆ m_port

int kanzi::connect::ClientSocketConnectionAdapter::m_port

protected

Configured server port.

◆ m_server

string kanzi::connect::ClientSocketConnectionAdapter::m_server

protected

Configured server address.

◆ m_set

::fd_set* kanzi::connect::ClientSocketConnectionAdapter::m_set

protected

Activated sockets during wait.

◆ m_signal

int kanzi::connect::ClientSocketConnectionAdapter::m_signal[2]

protected

◆ m_socket

Socket* kanzi::connect::ClientSocketConnectionAdapter::m_socket

protected

Socket used by this adapter.

◆ m_socketType

int kanzi::connect::ClientSocketConnectionAdapter::m_socketType

protected

Socket type.

◆ m_txBuffer

vector<char> kanzi::connect::ClientSocketConnectionAdapter::m_txBuffer

protected

◆ m_workResult

int kanzi::connect::ClientSocketConnectionAdapter::m_workResult

protected

Result of wait is stored here.

◆ m_writeSet

::fd_set* kanzi::connect::ClientSocketConnectionAdapter::m_writeSet

protected

◆ PARAMETER_HOST_IP

const string kanzi::connect::ClientSocketConnectionAdapter::PARAMETER_HOST_IP

static

Configuration parameter for server ip address.

◆ PARAMETER_HOST_PORT

const string kanzi::connect::ClientSocketConnectionAdapter::PARAMETER_HOST_PORT

static

Configuration parameter for server port.

◆ STATE_IP

const string kanzi::connect::ClientSocketConnectionAdapter::STATE_IP

static

State parameter to read adapter ip address back.

◆ STATE_PORT

const string kanzi::connect::ClientSocketConnectionAdapter::STATE_PORT

static

State parameter to read adapter port back.

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

connect/connection/connection_adapter_socket_client.hpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ClientSocketConnectionAdapter()

◆ ~ClientSocketConnectionAdapter()

Member Function Documentation

◆ clearTxQueue()

◆ configure()

◆ connect()

◆ discardFromTxQueue()

◆ disconnect()

◆ getState()

◆ hasPendingTxSocketData()

◆ interrupt()

◆ queueTxData()

◆ read()

◆ sendPendingTxSocketData()

◆ wait()

◆ work()

Member Data Documentation

◆ m_mutex

◆ m_port

◆ m_server

◆ m_set

◆ m_signal

◆ m_socket

◆ m_socketType

◆ m_txBuffer

◆ m_workResult

◆ m_writeSet

◆ PARAMETER_HOST_IP

◆ PARAMETER_HOST_PORT

◆ STATE_IP

◆ STATE_PORT