kanzi::connect::p2p::P2PClient::NetworkListenerRegistration Class Reference

Class to facade a network listener client and message dispatching. More...

#include <p2pclient.hpp>

Inheritance diagram for kanzi::connect::p2p::P2PClient::NetworkListenerRegistration:

Public Types
enum	State { StateDisconnected , StateConnecting , StateConnected , StateWaitingReconnect }

Public Member Functions
void	addStateChangeCallback (ConnectionStateChangedFunctionType callback)
	Insert callback to listen to registration changes.
bool	canHandleEndpoint (shared_ptr< p2p::RoutingRules::Endpoint > endpoint)
	Checks whether this paritucular network listener can handle the particular endpoint.
size_t	countEndpoints () const
	Return amount of endpoints the class has.
void	enableVerboseLogging (bool enable)
	Controls logging verbosity.
void	insertEndpoint (shared_ptr< p2p::RoutingRules::Endpoint > endpoint)
	Inserts a new endpoint.
bool	isConnected () const
	Connection state retrieval.
bool	isDisconnected () const
	Connection state retrieval.
	NetworkListenerRegistration (NetworkListenerClientSharedPtr networkListener, ClientSharedPtr client, int serverclientid, bool verboseLogging)
	Constructor.
virtual void	onConnected () override
	Listener thread has established connection to server.
virtual void	onDisconnected () override
	Listener thread has terminated connection from server.
virtual void	onFailedToConnect () override
	Listener thread failed to connect.
virtual void	onReceive () override
	Listener thread received data.
bool	refersToEndpoint (shared_ptr< p2p::RoutingRules::Endpoint > endpoint) const
	Checks whether this registration refers to a specified endpoint.
bool	removeEndpoint (shared_ptr< p2p::RoutingRules::Endpoint > endpoint)
	Removes a endpoint.
bool	startConnect ()
	Starts connection establishment.
void	stop ()
	Stops the operation including the worker thread.
string	toString ()
	Get stringular representation of the network connection.
bool	unreliableLink ()
	Describe the link type whether it is reliable or unreliable.
void	work ()
	To be invoked to process incoming messages from the network listener.
	~NetworkListenerRegistration ()
	Destructor.
Public Member Functions inherited from kanzi::connect::NetworkListenerClient::Observer
virtual	~Observer ()=default
Public Member Functions inherited from kanzi::connect::MessageDispatcher
virtual bool	getParameter (size_t id, size_t &param)
	Allows to retrieve a dispatcher specific parameter, mostly for internal use.
	MessageDispatcher ()
	Constructor.
virtual	~MessageDispatcher ()
	Destructor.

Protected Member Functions
virtual void	dispatch (const MessagePackage &message) override
	Dispatches this message to its destination.
string	stateToString (State state)
	Converts a state to its stringular expression.
void	toState (State state)
	Transfers to provided state.

Detailed Description

Class to facade a network listener client and message dispatching.

Member Enumeration Documentation

State

enum kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::State

Enumerator
StateDisconnected	Disconnected.
StateConnecting	Connecting started but not yet established.
StateConnected	Connected.
StateWaitingReconnect	After unsuccesfull connect a wait state after which next reconnect attempt is made.

Constructor & Destructor Documentation

NetworkListenerRegistration()

kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::NetworkListenerRegistration	(	NetworkListenerClientSharedPtr	networkListener,
		ClientSharedPtr	client,
		int	serverclientid,
		bool	verboseLogging )

Constructor.

Parameters

networkListener	The listener that this registration represents.
client	Client instance. Ownerhip is not transfered.
serverclientid	The identifier number that this client has on a server.
verboseLogging	When set to true, the information is printed in verbose manner.

~NetworkListenerRegistration()

kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::~NetworkListenerRegistration

(

)

Destructor.

Member Function Documentation

addStateChangeCallback()

void kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::addStateChangeCallback ( ConnectionStateChangedFunctionType callback )

inline

Insert callback to listen to registration changes.

Parameters

callback

The method to invoke for changes. You can set only one callback.

canHandleEndpoint()

bool kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::canHandleEndpoint

(

shared_ptr< p2p::RoutingRules::Endpoint >

endpoint

)

Checks whether this paritucular network listener can handle the particular endpoint.

Parameters

endpoint

the endpoint to check.

Returns

true if this listener can handle provided endpoint

countEndpoints()

size_t kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::countEndpoints

(

)

const

Return amount of endpoints the class has.

Returns

amount of endpoints

dispatch()

virtual void kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::dispatch ( const MessagePackage & message )

overrideprotectedvirtual

Dispatches this message to its destination.

Parameters

message

Message to dispatch.

Implements kanzi::connect::MessageDispatcher.

enableVerboseLogging()

void kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::enableVerboseLogging ( bool enable )

inline

Controls logging verbosity.

Parameters

enable

true to enable verbose logging from the class.

insertEndpoint()

void kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::insertEndpoint

(

shared_ptr< p2p::RoutingRules::Endpoint >

endpoint

)

Inserts a new endpoint.

Parameters

endpoint

the endpoint to insert

isConnected()

bool kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::isConnected ( ) const

inline

Connection state retrieval.

Returns

true if connected currently.

isDisconnected()

bool kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::isDisconnected ( ) const

inline

Connection state retrieval.

Returns

true if disconnected currently.

onConnected()

virtual void kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::onConnected ( )

overridevirtual

Listener thread has established connection to server.

Reimplemented from kanzi::connect::NetworkListenerClient::Observer.

onDisconnected()

virtual void kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::onDisconnected ( )

overridevirtual

Listener thread has terminated connection from server.

Reimplemented from kanzi::connect::NetworkListenerClient::Observer.

onFailedToConnect()

virtual void kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::onFailedToConnect ( )

overridevirtual

Listener thread failed to connect.

Reimplemented from kanzi::connect::NetworkListenerClient::Observer.

onReceive()

virtual void kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::onReceive ( )

overridevirtual

Listener thread received data.

Reimplemented from kanzi::connect::NetworkListenerClient::Observer.

refersToEndpoint()

bool kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::refersToEndpoint

(

shared_ptr< p2p::RoutingRules::Endpoint >

endpoint

)

const

Checks whether this registration refers to a specified endpoint.

Parameters

endpoint

the endpoint to check

Returns

true if refers to endpoint.

removeEndpoint()

bool kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::removeEndpoint

(

shared_ptr< p2p::RoutingRules::Endpoint >

endpoint

)

Removes a endpoint.

Parameters

endpoint

the endpoint to remove.

Returns

true if endpoint was referenced and got removed.

startConnect()

bool kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::startConnect

(

)

Starts connection establishment.

Returns

true if successfully started.

stateToString()

string kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::stateToString ( State state )

protected

Converts a state to its stringular expression.

Parameters

state

the state

Returns

name of the state

stop()

void kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::stop

(

)

Stops the operation including the worker thread.

toState()

void kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::toState ( State state )

protected

Transfers to provided state.

Parameters

state

the state to transfer to.

toString()

string kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::toString

(

)

Get stringular representation of the network connection.

mainly for debugging purposes

Returns

stringular representation of the network connection.

unreliableLink()

bool kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::unreliableLink

(

)

Describe the link type whether it is reliable or unreliable.

By default, all the links are assumed to be reliable unless otherwise explicitly stated by the network adapter

Returns

true if link is considered unreliable.

work()

void kanzi::connect::p2p::P2PClient::NetworkListenerRegistration::work

(

)

To be invoked to process incoming messages from the network listener.

---

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

• connect/p2p/p2pclient.hpp