A class that manages a service that is running remotely over the network. More...

#include <service_host.hpp>

Inheritance diagram for kanzi::connect::RemoteServiceHost:

Public Member Functions
void	initializeFlowControl (int credits, int creditreturninterval)
	Initialize flow control object. More...

bool	registerRoutingInformationSchema (const string &schema)
	Register routing information schema. More...

bool	registerServiceDescriptionSchema (const string &schema)
	Invoked to register service description xml. More...

	RemoteServiceHost (const string &type, shared_ptr< ServiceServiceConcept::Session > serviceSession, ServiceRuntimeDataRegistrySharedPtr registry=ServiceRuntimeDataRegistrySharedPtr())
	Constructor. More...

void	setClientDescriptor (ClientDescriptorSharedPtr clientDescription)
	Sets a client descriptor. More...

void	setDescription (const AbstractService::ServiceDescription &description)
	Set service description for a remote service. More...

virtual	~RemoteServiceHost () override
	Destructor. More...


virtual string	getIdentifier () const override
	Retrieve interface identifier. More...

virtual void	changeType (const string &type) override
	Changes the interface name at runtime. More...

virtual void	initialize (InterfaceDomainBase domain, ContentClientSharedPtr contentClient, WorkQueueInterface workQueue) override
	Initialize the service. More...

virtual void	uninitialize () override
	cleanup the service. More...

virtual AbstractSessionSharedPtr	acquireSession (ConnectedClientSharedPtr client, int sessionId) override
	Creates a session to this service. More...

virtual void	releaseSession (int clientId, int sessionId) override
	Releases a session. More...

virtual void	work (ConnectWorkItemSharedPtr workItem) override
	Routine that get(s) called periodically or especially when object itself has requested it to be called using the work queue. More...

virtual void	receiveMessage (ConnectedClientSharedPtr client, const MessagePackage &message) override
	Invoked for each message this service should handle. More...

virtual void	notifyClientDisconnected (int clientId) override
	Invoked to inform that specific client has disconnected. More...

virtual const AbstractService::ServiceDescription &	getDescription () override
	Retrieve the service description from service host. More...

virtual const AbstractService::ServiceState &	getState () override
	Retrieve the service state information. More...

virtual bool	local () const override
	Is this service local or not. More...

virtual shared_ptr< ServiceServiceConcept::Session >	getServiceSession () const override
	Returns a session to remote service. More...

virtual int	clientID () const override
	Returns the client identifier. More...

virtual AbstractServiceSharedPtr	getService () const override
	Returns a service instance. More...

virtual int	countSessions () const override
	Returns amount of sessions towards this service. More...

virtual ClientDescriptorSharedPtr	getClientDescriptor () override
	Return the client descriptor. More...

virtual void	setConfigurationProperties (RuntimeDataObjectSharedPtr properties) override
	Stores service configuration properties. More...

virtual RuntimeDataObjectSharedPtr	getConfigurationProperties () override
	Retrieve service configuration properties. More...

virtual void	setState (const AbstractService::ServiceState &state) override
	Sets the service state. More...

virtual string	getServiceRoutingInformationDescription (int serverclientid) override
	Must be overridden by the corresponding implementation. More...

virtual bool	reportServiceRuntimeData (const string &path, const string &stream) override
	Can be called, mainly for remote services, to inform about new service information that was received. More...

virtual void	notifyAll (const MessagePackage &event) override
	Internal API for scripting utilities makes assumptions on implementation details. More...

virtual RuntimeDataObject *	getRuntimeData () override
	Internal API for scripting utilities makes assumptions on implementation details. More...

Public Member Functions inherited from kanzi::connect::ServiceHost
virtual void	ensureDomain (ConnectDomainSharedPtr domain)
	Ensure that service instance (if local) has domain set. More...

virtual const string	getHash ()

virtual const string	getServiceDescriptionSchema (bool details=false)
	Retrieve service description schema. More...

virtual bool	registerServiceRuntimeData (const string schema="")
	Invoked to register service runtime data. More...

virtual bool	registerServiceRuntimeDataSchemaChange (const string &xml)
	Invoked to change runtime data schema at runtime. More...

	ServiceHost (ServiceRuntimeDataRegistrySharedPtr registry=ServiceRuntimeDataRegistrySharedPtr())
	C++ constructor. More...

virtual void	setConfigurationPropertyChangedCallback (ConfigurationPropertyChangedCallback callback)
	Install a callback to be invoked when configuration property changes. More...

virtual void	setHash (const string hash)

bool	subscribeForRuntimeDataSchemaChanges (GenericSyncObserver<> &observer)
	Start getting notifications of runtime data schema changes. More...

bool	unsubscribeForRuntimeDataSchemaChanges (GenericSyncObserver<> &observer)
	Stop receiving notifications of runtime data schema changes. More...

virtual	~ServiceHost ()
	Destructor. More...

Protected Member Functions
virtual void	getServiceDescriptionSchemaImpl (string &output) override

AbstractSessionSharedPtr	getSession (int clientId, int sessionId)

Additional Inherited Members
Public Types inherited from kanzi::connect::ServiceHost
typedef function< void(ServiceHost *, RuntimeDataObjectSharedPtr)>	ConfigurationPropertyChangedCallback
	Callback prototype to invoke when service configuration properties change. More...

Protected Attributes inherited from kanzi::connect::ServiceHost
ConfigurationPropertyChangedCallback	m_configurationPropertyChangedCallback

unique_ptr< RuntimeDataChildChangeMonitor >	m_configurationPropertyChangeMonitor

ServiceRuntimeDataRegistry::ContentRegistrationToken	m_runtimeDataRegistrationToken

ServiceRuntimeDataRegistrySharedPtr	m_runtimeDataRegistry
	Runtime data registry for convenient access. More...

GenericSyncPublisher	m_runtimeDataSchemaChangePublisher
	Publisher to use when runtime data schema changes within the ServiceHost. More...

AbstractService::RuntimeDataSchemaChangeSubscriptionToken	m_runtimeDataSchemaChangeSubscriptionToken

Detailed Description

A class that manages a service that is running remotely over the network.

Constructor & Destructor Documentation

◆ RemoteServiceHost()

kanzi::connect::RemoteServiceHost::RemoteServiceHost	(	const string &	type,
		shared_ptr< ServiceServiceConcept::Session >	serviceSession,
		ServiceRuntimeDataRegistrySharedPtr	registry = `ServiceRuntimeDataRegistrySharedPtr()`
	)

Constructor.

Parameters

type	the service interface identifier
serviceSession	pointer to session. Ownership does not transfer.

◆ ~RemoteServiceHost()

virtual kanzi::connect::RemoteServiceHost::~RemoteServiceHost ( )

overridevirtual

Destructor.

Member Function Documentation

◆ acquireSession()

virtual AbstractSessionSharedPtr kanzi::connect::RemoteServiceHost::acquireSession	(	ConnectedClientSharedPtr	client,
		int	sessionId
	)

overridevirtual

Creates a session to this service.

Parameters

client	identifies the client.
sessionId	identifies the session.

Returns: session instance. ownership not transfered.

Implements kanzi::connect::ServiceHost.

◆ changeType()

virtual void kanzi::connect::RemoteServiceHost::changeType ( const string & type )

overridevirtual

Changes the interface name at runtime.

Parameters

type	new type for the interface.

Implements kanzi::connect::ServiceHost.

◆ clientID()

virtual int kanzi::connect::RemoteServiceHost::clientID ( ) const

overridevirtual

Returns the client identifier.

Relevant only for remote clients. Will return -1 for local clients.

Returns: client identifier.

Implements kanzi::connect::ServiceHost.

◆ countSessions()

virtual int kanzi::connect::RemoteServiceHost::countSessions ( ) const

overridevirtual

Returns amount of sessions towards this service.

Returns: amount of sessions

Implements kanzi::connect::ServiceHost.

◆ getClientDescriptor()

virtual ClientDescriptorSharedPtr kanzi::connect::RemoteServiceHost::getClientDescriptor ( )

overridevirtual

Return the client descriptor.

Relevant only for remote services.

Returns: client descriptor

Implements kanzi::connect::ServiceHost.

◆ getConfigurationProperties()

virtual RuntimeDataObjectSharedPtr kanzi::connect::RemoteServiceHost::getConfigurationProperties ( )

overridevirtual

Retrieve service configuration properties.

Returns: properties as shared object.

Implements kanzi::connect::ServiceHost.

◆ getDescription()

virtual const AbstractService::ServiceDescription& kanzi::connect::RemoteServiceHost::getDescription ( )

overridevirtual

Retrieve the service description from service host.

Returns: const reference to service description

Implements kanzi::connect::ServiceHost.

◆ getIdentifier()

virtual string kanzi::connect::RemoteServiceHost::getIdentifier ( ) const

overridevirtual

Retrieve interface identifier.

Returns: interface ID this service handles.

Implements kanzi::connect::ServiceHost.

◆ getRuntimeData()

virtual RuntimeDataObject* kanzi::connect::RemoteServiceHost::getRuntimeData ( )

inlineoverridevirtual

Internal API for scripting utilities makes assumptions on implementation details.

Do not use.

Reimplemented from kanzi::connect::ServiceHost.

◆ getService()

virtual AbstractServiceSharedPtr kanzi::connect::RemoteServiceHost::getService ( ) const

inlineoverridevirtual

Returns a service instance.

Relevant only for local services.

Returns: service

Implements kanzi::connect::ServiceHost.

◆ getServiceDescriptionSchemaImpl()

virtual void kanzi::connect::RemoteServiceHost::getServiceDescriptionSchemaImpl ( string & output )

overrideprotectedvirtual

See also: ServiceHost::getServiceDescriptionSchemaImpl

Implements kanzi::connect::ServiceHost.

◆ getServiceRoutingInformationDescription()

virtual string kanzi::connect::RemoteServiceHost::getServiceRoutingInformationDescription ( int serverclientid )

overridevirtual

Must be overridden by the corresponding implementation.

Returns: xml format routing information for the service.

Implements kanzi::connect::ServiceHost.

◆ getServiceSession()

virtual shared_ptr<ServiceServiceConcept::Session> kanzi::connect::RemoteServiceHost::getServiceSession ( ) const

overridevirtual

Returns a session to remote service.

Relevant only for remote services.

Returns: session

Implements kanzi::connect::ServiceHost.

◆ getSession()

AbstractSessionSharedPtr kanzi::connect::RemoteServiceHost::getSession	(	int	clientId,
		int	sessionId
	)

protected

◆ getState()

virtual const AbstractService::ServiceState& kanzi::connect::RemoteServiceHost::getState ( )

overridevirtual

Retrieve the service state information.

Returns: const reference to service state information.

Implements kanzi::connect::ServiceHost.

◆ initialize()

virtual void kanzi::connect::RemoteServiceHost::initialize	(	InterfaceDomainBase *	domain,
		ContentClientSharedPtr	contentClient,
		WorkQueueInterface *	workQueue
	)

overridevirtual

Initialize the service.

Parameters

domain	environment where the service is run in.
contentClient	access to content system
workQueue	interface to work queue used to dispatch work service is ready will eventually cause the services work() method to be invoked.

Implements kanzi::connect::ServiceHost.

◆ initializeFlowControl()

void kanzi::connect::RemoteServiceHost::initializeFlowControl	(	int	credits,
		int	creditreturninterval
	)

Initialize flow control object.

Parameters

credits	amount of credits initially
creditreturninterval	how often return credits to service.

◆ local()

virtual bool kanzi::connect::RemoteServiceHost::local ( ) const

overridevirtual

Is this service local or not.

Returns: true if service is local

Implements kanzi::connect::ServiceHost.

◆ notifyAll()

virtual void kanzi::connect::RemoteServiceHost::notifyAll ( const MessagePackage & event )

inlineoverridevirtual

Internal API for scripting utilities makes assumptions on implementation details.

Do not use.

Reimplemented from kanzi::connect::ServiceHost.

◆ notifyClientDisconnected()

virtual void kanzi::connect::RemoteServiceHost::notifyClientDisconnected ( int clientId )

overridevirtual

Invoked to inform that specific client has disconnected.

Parameters

clientId Identifies the client.

Implements kanzi::connect::ServiceHost.

◆ receiveMessage()

virtual void kanzi::connect::RemoteServiceHost::receiveMessage	(	ConnectedClientSharedPtr	client,
		const MessagePackage &	message
	)

overridevirtual

Invoked for each message this service should handle.

Parameters

client	identifies the message sender
message	the message to process.

Implements kanzi::connect::ServiceHost.

◆ registerRoutingInformationSchema()

bool kanzi::connect::RemoteServiceHost::registerRoutingInformationSchema ( const string & schema )

Register routing information schema.

Parameters

routing information schema to register.

Returns: true if registration succeeds.

◆ registerServiceDescriptionSchema()

bool kanzi::connect::RemoteServiceHost::registerServiceDescriptionSchema ( const string & schema )

Invoked to register service description xml.

Parameters

schema the schema (xml)

Returns: true if registration succeeded.

◆ releaseSession()

virtual void kanzi::connect::RemoteServiceHost::releaseSession	(	int	clientId,
		int	sessionId
	)

overridevirtual

Releases a session.

Parameters

clientId	identifies the client
sessionId	identifies the session

Implements kanzi::connect::ServiceHost.

◆ reportServiceRuntimeData()

virtual bool kanzi::connect::RemoteServiceHost::reportServiceRuntimeData	(	const string &	path,
		const string &	stream
	)

overridevirtual

Can be called, mainly for remote services, to inform about new service information that was received.

Reimplemented from kanzi::connect::ServiceHost.

◆ setClientDescriptor()

void kanzi::connect::RemoteServiceHost::setClientDescriptor ( ClientDescriptorSharedPtr clientDescription )

Sets a client descriptor.

Parameters

clientDescription The information to set.

◆ setConfigurationProperties()

virtual void kanzi::connect::RemoteServiceHost::setConfigurationProperties ( RuntimeDataObjectSharedPtr properties )

overridevirtual

Stores service configuration properties.

Default implementation is empty, should be overridden by the remote service host implementation

Parameters

properties data object describing the properties.

Reimplemented from kanzi::connect::ServiceHost.

◆ setDescription()

void kanzi::connect::RemoteServiceHost::setDescription ( const AbstractService::ServiceDescription & description )

Set service description for a remote service.

Parameters

description the description to set

◆ setState()

virtual void kanzi::connect::RemoteServiceHost::setState ( const AbstractService::ServiceState & state )

overridevirtual

Sets the service state.

Relevant only for remote clients.

Parameters

state new state for remote clients.

Implements kanzi::connect::ServiceHost.

◆ uninitialize()

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

overridevirtual

cleanup the service.

Implements kanzi::connect::ServiceHost.

◆ work()

virtual void kanzi::connect::RemoteServiceHost::work ( ConnectWorkItemSharedPtr workItem )

overridevirtual

Routine that get(s) called periodically or especially when object itself has requested it to be called using the work queue.

Parameters

workItem Item to be processed.

Implements kanzi::connect::ServiceHost.

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

service_service/service_host.hpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RemoteServiceHost()

◆ ~RemoteServiceHost()

Member Function Documentation

◆ acquireSession()

◆ changeType()

◆ clientID()

◆ countSessions()

◆ getClientDescriptor()

◆ getConfigurationProperties()

◆ getDescription()

◆ getIdentifier()

◆ getRuntimeData()

◆ getService()

◆ getServiceDescriptionSchemaImpl()

◆ getServiceRoutingInformationDescription()

◆ getServiceSession()

◆ getSession()

◆ getState()

◆ initialize()

◆ initializeFlowControl()

◆ local()

◆ notifyAll()

◆ notifyClientDisconnected()

◆ receiveMessage()

◆ registerRoutingInformationSchema()

◆ registerServiceDescriptionSchema()

◆ releaseSession()

◆ reportServiceRuntimeData()

◆ setClientDescriptor()

◆ setConfigurationProperties()

◆ setDescription()

◆ setState()

◆ uninitialize()

◆ work()