A class that is used to deliver interface network messages between client and server. More...

#include <abstract_session.hpp>

Inheritance diagram for kanzi::connect::AbstractSession:

Public Types
typedef function< bool(const MessagePackage &message)	MessageReceivedFunction)
	Message subscription callback.

typedef shared_ptr< void >	MessageSubscriptionToken

typedef unordered_map< string, string >	ServiceAttributes

Public Member Functions
	AbstractSession (const string &interfaceId, int clientId, int sessionId, MessageDispatcher *dispatcher)
	Constructor.

MessageSubscriptionToken	addMessageSubscription (const string &messageType, MessageReceivedFunction function)
	Subscribe all messages of type.

MessageSubscriptionToken	addMessageTypeSubscription (int messageType, MessageReceivedFunction function)
	Subscribe all messages of Message Package type.

MessageSubscriptionToken	addRegexMessageSubscription (const string &regex, MessageReceivedFunction function)
	Subscribe all messages that match a regular expression.

void	changeMessageDispatcher (MessageDispatcher *dispatcher)
	Changes message dispatcher on the fly.

void	enableVerboseLogging (bool enable)
	Enables verbose logging for the functionality.

ClientDescriptorSharedPtr	getClientDescriptor () const
	Retrieve client descriptor.

int	getClientId () const
	Retrieve client id of the session.

int	getId () const
	Retrieve id of the session.

const string &	getInterfaceId () const
	Retrieve id of the interface.

int	getServerClientId () const
	Retrieve server client identifier of the session.

const ServiceAttributes &	getServiceAttributes ()

virtual void	initialize ()
	Initializes this session.

void	receive (const MessagePackage &message)
	Asks session to process received message.

void	removeMessageSubscription (const string &messageType, MessageSubscriptionToken token)
	Remove message subscription.

void	removeMessageTypeSubscription (int messageType, MessageSubscriptionToken token)
	Remove message subscription.

void	removeRegexMessageSubscription (const string &regex, MessageSubscriptionToken token)
	Remove regular expression message subscription.

void	setClientDescriptor (ClientDescriptorSharedPtr clientDescriptor)
	Saves a client descriptor of the client who created this session.

void	setClientP2PRoutingInstructions (shared_ptr< p2p::P2PClient::RoutingHandler > routingHandler)
	Configure P2P routing instructions for the client.

void	setGenericInvoker (GenericInvoker *invoker)
	Setups generic invocation mechanism.

void	setServerClientId (int id)
	Sets servers identifier of the client this session belongs to.

void	setServerP2PRouter (p2p::P2PServerSharedPtr serverRouter)
	Configure P2P routing for server scope.

void	terminate ()
	Terminates the session.

bool	transmit (const MessagePackage &message)
	Sends outgoing message to network.

bool	transmit (MessagePackageSharedPtr message, uint32_t call_handle=0)
	Sends outgoing message to network.

virtual void	uninitialize ()
	Un-initializes this session.

void	updateEnabledState (bool newEnabledState)
	Update the enabled state of this session.

virtual	~AbstractSession ()
	Destructor.

Protected Member Functions
virtual shared_ptr< GenericRPCReplyMessage >	onReceiveMessage (const MessagePackage &message)
	Allows derived class to receive notification of received message.

virtual void	onTransmitMessage (const MessagePackage &message)
	Allows derived class to receive notification of transmitted message.

Detailed Description

A class that is used to deliver interface network messages between client and server.

In order to use a service, client needs always first to establish a session to interface.

Member Typedef Documentation

◆ MessageReceivedFunction

typedef function<bool(const MessagePackage& message) kanzi::connect::AbstractSession::MessageReceivedFunction)

Message subscription callback.

Returns: True if message was handled and framework does not need to process it further.

◆ MessageSubscriptionToken

typedef shared_ptr<void> kanzi::connect::AbstractSession::MessageSubscriptionToken

◆ ServiceAttributes

typedef unordered_map<string, string> kanzi::connect::AbstractSession::ServiceAttributes

Constructor & Destructor Documentation

◆ AbstractSession()

kanzi::connect::AbstractSession::AbstractSession	(	const string &	interfaceId,
		int	clientId,
		int	sessionId,
		MessageDispatcher *	dispatcher )

Constructor.

Parameters

interfaceId	Id of the interface.
clientId	Id of the client.
sessionId	Id of the session.
dispatcher	Message dispatcher that can be used to deliver network messages.

◆ ~AbstractSession()

virtual kanzi::connect::AbstractSession::~AbstractSession ( )

virtual

Destructor.

Member Function Documentation

◆ addMessageSubscription()

MessageSubscriptionToken kanzi::connect::AbstractSession::addMessageSubscription	(	const string &	messageType,
		MessageReceivedFunction	function )

Subscribe all messages of type.

Parameters

messageType	Type of the messages to subscribe callbacks.
function	Callback to pass the subscribed messages.

Returns: Subscription token which is needed to unsubscribe callbacks.

◆ addMessageTypeSubscription()

MessageSubscriptionToken kanzi::connect::AbstractSession::addMessageTypeSubscription	(	int	messageType,
		MessageReceivedFunction	function )

Subscribe all messages of Message Package type.

Parameters

messageType Type of the messages to subscribe callbacks.

See also: : MessagePackage::MessageType

Parameters

function Callback to pass the subscribed messages.

Returns: Subscription token which is needed to unsubscribe callbacks.

◆ addRegexMessageSubscription()

MessageSubscriptionToken kanzi::connect::AbstractSession::addRegexMessageSubscription	(	const string &	regex,
		MessageReceivedFunction	function )

Subscribe all messages that match a regular expression.

Parameters

regex	Regular expression for matching messages.
function	Callback to pass the subscribed messages.

Returns: Subscription token which is needed to unsubscribe callbacks.

◆ changeMessageDispatcher()

void kanzi::connect::AbstractSession::changeMessageDispatcher ( MessageDispatcher * dispatcher )

Changes message dispatcher on the fly.

Parameters

dispatcher the new dispatcher to take into use.

◆ enableVerboseLogging()

void kanzi::connect::AbstractSession::enableVerboseLogging ( bool enable )

Enables verbose logging for the functionality.

Parameters

enable true to enable. defaults to false.

◆ getClientDescriptor()

ClientDescriptorSharedPtr kanzi::connect::AbstractSession::getClientDescriptor ( ) const

Retrieve client descriptor.

Returns: client descriptor

◆ getClientId()

int kanzi::connect::AbstractSession::getClientId ( ) const

Retrieve client id of the session.

Returns: Network id of the client.

◆ getId()

int kanzi::connect::AbstractSession::getId ( ) const

Retrieve id of the session.

Returns: Id of the session, unique for this client.

◆ getInterfaceId()

const string & kanzi::connect::AbstractSession::getInterfaceId ( ) const

Retrieve id of the interface.

Returns: Id of the connected interface.

◆ getServerClientId()

int kanzi::connect::AbstractSession::getServerClientId ( ) const

Retrieve server client identifier of the session.

Returns: the server identifier for this client inside the server.

◆ getServiceAttributes()

const ServiceAttributes & kanzi::connect::AbstractSession::getServiceAttributes ( )

inline

◆ initialize()

virtual void kanzi::connect::AbstractSession::initialize ( )

virtual

Initializes this session.

◆ onReceiveMessage()

virtual shared_ptr< GenericRPCReplyMessage > kanzi::connect::AbstractSession::onReceiveMessage ( const MessagePackage & message )

protectedvirtual

Allows derived class to receive notification of received message.

Parameters

message Message that was received.

Reimplemented in kanzi::connect::ExternalServiceSession, and kanzi::connect::ClientStreamSession.

◆ onTransmitMessage()

virtual void kanzi::connect::AbstractSession::onTransmitMessage ( const MessagePackage & message )

protectedvirtual

Allows derived class to receive notification of transmitted message.

Parameters

message Message to send.

◆ receive()

void kanzi::connect::AbstractSession::receive ( const MessagePackage & message )

Asks session to process received message.

Parameters

message Message that was received.

◆ removeMessageSubscription()

void kanzi::connect::AbstractSession::removeMessageSubscription	(	const string &	messageType,
		MessageSubscriptionToken	token )

Remove message subscription.

Parameters

messageType	Type of the messages to unsubscribe callbacks.
token	Subscription token.

◆ removeMessageTypeSubscription()

void kanzi::connect::AbstractSession::removeMessageTypeSubscription	(	int	messageType,
		MessageSubscriptionToken	token )

Remove message subscription.

Parameters

messageType Type of the messages to unsubscribe callbacks.

See also: : MessagePackage::MessageType

Parameters

token Subscription token.

◆ removeRegexMessageSubscription()

void kanzi::connect::AbstractSession::removeRegexMessageSubscription	(	const string &	regex,
		MessageSubscriptionToken	token )

Remove regular expression message subscription.

Parameters

regex	Regular expression to unsubscribe.
token	Subscription token.

◆ setClientDescriptor()

void kanzi::connect::AbstractSession::setClientDescriptor ( ClientDescriptorSharedPtr clientDescriptor )

Saves a client descriptor of the client who created this session.

Parameters

clientDescriptor

◆ setClientP2PRoutingInstructions()

void kanzi::connect::AbstractSession::setClientP2PRoutingInstructions ( shared_ptr< p2p::P2PClient::RoutingHandler > routingHandler )

Configure P2P routing instructions for the client.

Parameters

routingHandler the instructions to apply.

◆ setGenericInvoker()

void kanzi::connect::AbstractSession::setGenericInvoker ( GenericInvoker * invoker )

Setups generic invocation mechanism.

Parameters

invoker generic invocation mechanism.

◆ setServerClientId()

void kanzi::connect::AbstractSession::setServerClientId ( int id )

Sets servers identifier of the client this session belongs to.

Parameters

id	the identifier.

◆ setServerP2PRouter()

void kanzi::connect::AbstractSession::setServerP2PRouter ( p2p::P2PServerSharedPtr serverRouter )

Configure P2P routing for server scope.

Parameters

serverRouter routing functionality for server.

◆ terminate()

void kanzi::connect::AbstractSession::terminate ( )

Terminates the session.

◆ transmit() [1/2]

bool kanzi::connect::AbstractSession::transmit ( const MessagePackage & message )

Sends outgoing message to network.

Parameters

message Message to send.

◆ transmit() [2/2]

bool kanzi::connect::AbstractSession::transmit	(	MessagePackageSharedPtr	message,
		uint32_t	call_handle = 0 )

Sends outgoing message to network.

Parameters

message Message to send.

◆ uninitialize()

virtual void kanzi::connect::AbstractSession::uninitialize ( )

virtual

Un-initializes this session.

◆ updateEnabledState()

void kanzi::connect::AbstractSession::updateEnabledState ( bool newEnabledState )

Update the enabled state of this session.

Parameters

newEnabledState The new status.

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

connect/interface/abstract_session.hpp

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ MessageReceivedFunction

◆ MessageSubscriptionToken

◆ ServiceAttributes

Constructor & Destructor Documentation

◆ AbstractSession()

◆ ~AbstractSession()

Member Function Documentation

◆ addMessageSubscription()

◆ addMessageTypeSubscription()

◆ addRegexMessageSubscription()

◆ changeMessageDispatcher()

◆ enableVerboseLogging()

◆ getClientDescriptor()

◆ getClientId()

◆ getId()

◆ getInterfaceId()

◆ getServerClientId()

◆ getServiceAttributes()

◆ initialize()

◆ onReceiveMessage()

◆ onTransmitMessage()

◆ receive()

◆ removeMessageSubscription()

◆ removeMessageTypeSubscription()

◆ removeRegexMessageSubscription()

◆ setClientDescriptor()

◆ setClientP2PRoutingInstructions()

◆ setGenericInvoker()

◆ setServerClientId()

◆ setServerP2PRouter()

◆ terminate()

◆ transmit() [1/2]

◆ transmit() [2/2]

◆ uninitialize()

◆ updateEnabledState()