A class that manages all services in Kanzi Connect Server. More...

#include <service_manager.hpp>

Inheritance diagram for kanzi::connect::ServiceManager:

Classes
class	ServiceInfo
	Info and details for a running service. More...

Public Types
typedef function< void(vector< ServiceManager::ServiceInfo >)>	InformationChangedCallbackFunction
	Function prototype to be invoked when information changes.

typedef shared_ptr< void >	InformationChangedSubscriptionToken
	Handle given as return value to state callback registration.

Public Types inherited from kanzi::connect::IncomingMessageInterface
enum	Status { Ok = 0 , ErrorGeneric , ErrorInvalidMessage , ErrorUnknownDestination , ErrorNotRunning }

typedef enum kanzi::connect::IncomingMessageInterface::Status	Status

Public Member Functions
InformationChangedSubscriptionToken	addInformationChangeSubscription (InformationChangedCallbackFunction callback)
	Adds observer to listen service information change messages.

void	createDefinedServices ()
	Creates and registers an instance of each service (Connect.Service.

ServiceHostSharedPtr	getRemoteServiceHost (AbstractSessionSharedPtr session)
	Tries to resolve a remote service host that is somehow bound to a given abstract session.

ServiceRuntimeDataRegistrySharedPtr	getRuntimeDataRegistry ()
	Retrieve shared runtime data registry.

vector< ContentProviderSharedPtr >	getServiceContentProviders (const string &service)
	Retrieve the content providers bound to a specific service.

ServiceHostSharedPtr	getServiceHost (const string &id)
	Retrieves the service host associated with the provided interface identifier.

bool	isCoreService (const string &name) const
	Determines whether specific service is a core service.

vector< ServiceInfo >	listServices ()
	retrieves list of services with information attached.

virtual AbstractServiceSharedPtr	lookupLocalService (const string name) override
	Performs a lookup for local service that is registered with specific name.

void	notifyInformationObservers ()
	Calls all registered information observers in a delayed manner through the mainloop.

void	queueServiceForStartup (string serviceName)
	Store service name in vector queue for startup.

bool	registerService (AbstractServiceSharedPtr service)
	Registers service object to system.

void	removeInformationChangeSubscription (InformationChangedSubscriptionToken token)
	Removes observer.

	ServiceManager (ConnectDomainSharedPtr domain, DiagnosticsManagerSharedPtr diagnostics)
	Constructor.

void	setHttpServer (shared_ptr< CivetServer > httpServer)
	Set HTTP server to handle HTTP requests.

void	setPolicyMessageFilter (messagefilter::ServiceMessageFilterHandler handler)
	Configures a filter handler for incoming messages.

bool	start (ConnectDomainSharedPtr domain, ContentClientSharedPtr contentClient, WorkQueueInterface *workQueue)
	Starts and initializes all services.

bool	stop ()
	Stops and uninitializes all services.

bool	unregisterService (AbstractServiceSharedPtr service)
	Unregisters service object from server.

	~ServiceManager ()
	Destructor.

Public Member Functions inherited from kanzi::connect::InterfaceDomainBase
const string &	getResourceDirectory () const
	Retrieves the content & resource directory of the system.

UriTranslator &	getUriTranslator ()
	Returns translator for Uris.

void	setResourceDirectory (const string &path)
	Sets resource directory of the system.

virtual	~InterfaceDomainBase ()=default
	Destructor.

Public Member Functions inherited from kanzi::connect::LocalServiceDiscoveryInterface
virtual	~LocalServiceDiscoveryInterface ()
	Virtual destructor.

Public Member Functions inherited from kanzi::connect::VirtualFileProvider
virtual void	cancelAllPendingRequests ()

virtual	~VirtualFileProvider ()
	Virtual destructor for cleanup.

Protected Member Functions
bool	acquireSession (ConnectedClientSharedPtr client, const string &interfaceId, int sessionId)
	Acquires a new session for a client for a particular service.

void	automaticStartLocalServices ()
	Automatically starts all non-demand configured services.

bool	canStartService (AbstractServiceSharedPtr service)
	Checks whether it is allowed to start specific service.

bool	canStopService (AbstractServiceSharedPtr service)
	Checks whether it is allowed to stop specific service.

void	configureService (AbstractServiceSharedPtr service)
	Configures service attributes.

void	notifyInformationObserversImpl ()
	Calls all registered information observers.

virtual AbstractSessionSharedPtr	onAcquireSession (int clientId, int sessionId, MessageDispatcher *dispatcher, const string &instanceName) override
	See AbstractService::onAcquireSession.

virtual void	onReleaseSession (AbstractSessionSharedPtr session) override
	See AbstractService::onReleaseSession.

bool	registerCoreService (AbstractServiceSharedPtr service)
	Registers a core service.

void	registerServiceRuntimeDatas ()
	Register runtime data from all the services within the system.

bool	releaseSession (int clientId, const string &interfaceId, int sessionId)
	Releases ongoing session.

Friends
class	Server

Detailed Description

A class that manages all services in Kanzi Connect Server.

This class allows both local and remote services to register in to system and manages the lifetime, operation and connectivity of all registered services.

Member Typedef Documentation

◆ InformationChangedCallbackFunction

typedef function<void(vector<ServiceManager::ServiceInfo>)> kanzi::connect::ServiceManager::InformationChangedCallbackFunction

Function prototype to be invoked when information changes.

◆ InformationChangedSubscriptionToken

typedef shared_ptr<void> kanzi::connect::ServiceManager::InformationChangedSubscriptionToken

Handle given as return value to state callback registration.

Constructor & Destructor Documentation

◆ ServiceManager()

kanzi::connect::ServiceManager::ServiceManager	(	ConnectDomainSharedPtr	domain,
		DiagnosticsManagerSharedPtr	diagnostics )

Constructor.

◆ ~ServiceManager()

kanzi::connect::ServiceManager::~ServiceManager ( )

Destructor.

Member Function Documentation

◆ acquireSession()

bool kanzi::connect::ServiceManager::acquireSession	(	ConnectedClientSharedPtr	client,
		const string &	interfaceId,
		int	sessionId )

protected

Acquires a new session for a client for a particular service.

Parameters

client	the client.
interfaceId	Id of the interface.
sessionId	Id of the session.

Returns: true if session successfully acquired. false on error

◆ addInformationChangeSubscription()

InformationChangedSubscriptionToken kanzi::connect::ServiceManager::addInformationChangeSubscription ( InformationChangedCallbackFunction callback )

Adds observer to listen service information change messages.

Parameters

callback function to call on change. Execution contenxt might vary.

Returns: token that can later on be used to remove subscription.

◆ automaticStartLocalServices()

void kanzi::connect::ServiceManager::automaticStartLocalServices ( )

protected

Automatically starts all non-demand configured services.

◆ canStartService()

bool kanzi::connect::ServiceManager::canStartService ( AbstractServiceSharedPtr service )

protected

Checks whether it is allowed to start specific service.

Decision is based on the dependency information provided with the server configuration.

Parameters

service the service to be checked.

Returns: true if it is allowed to start service.

◆ canStopService()

bool kanzi::connect::ServiceManager::canStopService ( AbstractServiceSharedPtr service )

protected

Checks whether it is allowed to stop specific service.

Decision is based on the dependency information provided with the server configuration.

Parameters

service the service to be checked.

Returns: true if it is allowed to stop service.

◆ configureService()

void kanzi::connect::ServiceManager::configureService ( AbstractServiceSharedPtr service )

protected

Configures service attributes.

Parameters

service pointer to service instance.

◆ createDefinedServices()

void kanzi::connect::ServiceManager::createDefinedServices ( )

Creates and registers an instance of each service (Connect.Service.

*) that is found from the metadata. Note: This functionality is likely to change in future.

◆ getRemoteServiceHost()

ServiceHostSharedPtr kanzi::connect::ServiceManager::getRemoteServiceHost ( AbstractSessionSharedPtr session )

Tries to resolve a remote service host that is somehow bound to a given abstract session.

Parameters

session the abstract session to resolve.

Returns: service host pointer that could be a null.

◆ getRuntimeDataRegistry()

ServiceRuntimeDataRegistrySharedPtr kanzi::connect::ServiceManager::getRuntimeDataRegistry ( )

Retrieve shared runtime data registry.

Returns: runtime data registry.

◆ getServiceContentProviders()

vector< ContentProviderSharedPtr > kanzi::connect::ServiceManager::getServiceContentProviders ( const string & service )

Retrieve the content providers bound to a specific service.

Parameters

service the name of the service

Returns: vector of content providers bound to this particular service.

◆ getServiceHost()

ServiceHostSharedPtr kanzi::connect::ServiceManager::getServiceHost ( const string & id )

Retrieves the service host associated with the provided interface identifier.

Parameters

id	identifies the interface

Returns: pointer to service host.

◆ isCoreService()

bool kanzi::connect::ServiceManager::isCoreService ( const string & name ) const

Determines whether specific service is a core service.

Parameters

name	name of the service.

Returns: true if service is a core service.

◆ listServices()

vector< ServiceInfo > kanzi::connect::ServiceManager::listServices ( )

retrieves list of services with information attached.

Returns: list of service decriptors.

◆ lookupLocalService()

virtual AbstractServiceSharedPtr kanzi::connect::ServiceManager::lookupLocalService ( const string name )

overridevirtual

Performs a lookup for local service that is registered with specific name.

Parameters

name	the name of the service, usually something like Connect.Service.MyProService or just MyProService

Returns: pointer to service or null.

Implements kanzi::connect::LocalServiceDiscoveryInterface.

◆ notifyInformationObservers()

void kanzi::connect::ServiceManager::notifyInformationObservers ( )

Calls all registered information observers in a delayed manner through the mainloop.

◆ notifyInformationObserversImpl()

void kanzi::connect::ServiceManager::notifyInformationObserversImpl ( )

protected

Calls all registered information observers.

◆ onAcquireSession()

virtual AbstractSessionSharedPtr kanzi::connect::ServiceManager::onAcquireSession	(	int	clientId,
		int	sessionId,
		MessageDispatcher *	dispatcher,
		const string &	instanceName )

overrideprotectedvirtual

See AbstractService::onAcquireSession.

◆ onReleaseSession()

virtual void kanzi::connect::ServiceManager::onReleaseSession ( AbstractSessionSharedPtr session )

overrideprotectedvirtual

See AbstractService::onReleaseSession.

◆ queueServiceForStartup()

void kanzi::connect::ServiceManager::queueServiceForStartup ( string serviceName )

Store service name in vector queue for startup.

Parameters

serviceName to be stored

◆ registerCoreService()

bool kanzi::connect::ServiceManager::registerCoreService ( AbstractServiceSharedPtr service )

protected

Registers a core service.

Parameters

service pointer to service instsance

Returns: true if succeeded, false otherwise.

◆ registerService()

bool kanzi::connect::ServiceManager::registerService ( AbstractServiceSharedPtr service )

Registers service object to system.

Parameters

service Service to register.

Returns: true if ok, false if registration failed, most likely due the fact service with same name already existed.

◆ registerServiceRuntimeDatas()

void kanzi::connect::ServiceManager::registerServiceRuntimeDatas ( )

protected

Register runtime data from all the services within the system.

◆ releaseSession()

bool kanzi::connect::ServiceManager::releaseSession	(	int	clientId,
		const string &	interfaceId,
		int	sessionId )

protected

Releases ongoing session.

Parameters

clientId	Id of the client.
interfaceId	Id of the interface.
sessionId	Id of the session.

Returns: true if session got released, false otherwise.

◆ removeInformationChangeSubscription()

void kanzi::connect::ServiceManager::removeInformationChangeSubscription ( InformationChangedSubscriptionToken token )

Removes observer.

Parameters

token previously returned subscription token

◆ setHttpServer()

void kanzi::connect::ServiceManager::setHttpServer ( shared_ptr< CivetServer > httpServer )

Set HTTP server to handle HTTP requests.

Parameters

httpServer HTTP server to handle HTTP requests.

◆ setPolicyMessageFilter()

void kanzi::connect::ServiceManager::setPolicyMessageFilter ( messagefilter::ServiceMessageFilterHandler handler )

Configures a filter handler for incoming messages.

Parameters

handler the handler to set for incoming messages.

◆ start()

bool kanzi::connect::ServiceManager::start	(	ConnectDomainSharedPtr	domain,
		ContentClientSharedPtr	contentClient,
		WorkQueueInterface *	workQueue )

Starts and initializes all services.

Parameters

domain	contains setup data
contentClient	interface to content service
workQueue	global work queue pointer

Returns: true if successfully started. false if unable to start services.

◆ stop()

bool kanzi::connect::ServiceManager::stop ( )

Stops and uninitializes all services.

Returns: true if succeeded. false on error.

◆ unregisterService()

bool kanzi::connect::ServiceManager::unregisterService ( AbstractServiceSharedPtr service )

Unregisters service object from server.

Parameters

service Service to unregister.

Returns: true if service got removed. false if service not found or passed arguments were invalid.

Friends And Related Symbol Documentation

◆ Server

friend class Server

friend

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

service_service/service_manager.hpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ InformationChangedCallbackFunction

◆ InformationChangedSubscriptionToken

Constructor & Destructor Documentation

◆ ServiceManager()

◆ ~ServiceManager()

Member Function Documentation

◆ acquireSession()

◆ addInformationChangeSubscription()

◆ automaticStartLocalServices()

◆ canStartService()

◆ canStopService()

◆ configureService()

◆ createDefinedServices()

◆ getRemoteServiceHost()

◆ getRuntimeDataRegistry()

◆ getServiceContentProviders()

◆ getServiceHost()

◆ isCoreService()

◆ listServices()

◆ lookupLocalService()

◆ notifyInformationObservers()

◆ notifyInformationObserversImpl()

◆ onAcquireSession()

◆ onReleaseSession()

◆ queueServiceForStartup()

◆ registerCoreService()

◆ registerService()

◆ registerServiceRuntimeDatas()

◆ releaseSession()

◆ removeInformationChangeSubscription()

◆ setHttpServer()

◆ setPolicyMessageFilter()

◆ start()

◆ stop()

◆ unregisterService()

Friends And Related Symbol Documentation

◆ Server