kanzi::connect::ExternalServiceSession Class Reference

External service session implementation. More...

#include <externalserviceadapter.hpp>

Inheritance diagram for kanzi::connect::ExternalServiceSession:

Public Member Functions
	ExternalServiceSession (ExternalServiceAdapter &service, int clientId, int sessionId, MessageDispatcher *dispatcher, const string &instanceName)
	Constructor.
bool	transmitToSession (const MessagePackage &message)
	Transmits a message to this session.
Public Member Functions inherited from kanzi::connect::AbstractSession
	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.
Protected Member Functions inherited from kanzi::connect::AbstractSession
virtual void	onTransmitMessage (const MessagePackage &message)
	Allows derived class to receive notification of transmitted message.

Additional Inherited Members
Public Types inherited from kanzi::connect::AbstractSession
typedef function< bool(const MessagePackage &message)	MessageReceivedFunction)
	Message subscription callback.
typedef shared_ptr< void >	MessageSubscriptionToken
typedef unordered_map< string, string >	ServiceAttributes

Detailed Description

External service session implementation.

Constructor & Destructor Documentation

ExternalServiceSession()

kanzi::connect::ExternalServiceSession::ExternalServiceSession	(	ExternalServiceAdapter &	service,
		int	clientId,
		int	sessionId,
		MessageDispatcher *	dispatcher,
		const string &	instanceName )

Constructor.

Parameters

service	the service owning this session
clientId	the client identifier/handle
sessionId	Session identifier/handle
instanceName	name of the instance.

Member Function Documentation

onReceiveMessage()

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

protectedvirtual

Allows derived class to receive notification of received message.

Parameters

message

Message that was received.

Reimplemented from kanzi::connect::AbstractSession.

transmitToSession()

bool kanzi::connect::ExternalServiceSession::transmitToSession

(

const MessagePackage &

message

)

Transmits a message to this session.

Parameters

message

the message to transmit

---

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

• connect/interface/externalserviceadapter.hpp