kanzi::connect::ServiceRuntimeDataRegistry Class Reference

Encapsulates service runtime data. More...

#include <serviceruntimedataregisterer.hpp>

Inheritance diagram for kanzi::connect::ServiceRuntimeDataRegistry:

Public Types
typedef shared_ptr< void >	ContentRegistrationToken
typedef shared_ptr< void >	ContentSubscriptionToken
typedef function< void(const string &, const string &)	RuntimeContentUpdateCallback)

Public Member Functions
RuntimeDataObjectSharedPtr	getRootObjectForRegistration (ContentRegistrationToken token)
	Retrieves the root object associated with the specific content registration token.
RuntimeDataObjectSharedPtr	getRootObjectForSubscription (ContentSubscriptionToken token)
	Retrieves the root object associated with the specific content listener token.
const string	getSchemaForSubscription (ContentSubscriptionToken token)
	Retrieve XML format schema for content subscription.
void	initializeHTTP ()
	Initializes HTTP Functionality.
ContentSubscriptionToken	registerContentListener (const string &path, RuntimeContentUpdateCallback callback)
	Registers runtime content listener to a specific path.
ContentRegistrationToken	registerContentProducer (const string &servicename, const string &xml)
	Registers a content producer from XML schema definition.
ContentRegistrationToken	registerContentProducer (const string &servicename, RuntimeDataObjectSharedPtr dataRoot, const string &schema)
	Registers a content producer, aka a service.
bool	renameContentProducer (const string &oldname, const string &newname)
	Renames a content producer.
	ServiceRuntimeDataRegistry (ConnectDomainSharedPtr domain=nullptr, DiagnosticsManagerSharedPtr diagnostics=DiagnosticsManagerSharedPtr())
	C++ constructor.
void	uninitializeHTTP ()
	Uninitialize HTTP Functionality.
void	unregisterContentListener (ContentSubscriptionToken token)
	Unregisters content listener.
void	unregisterContentProducer (ContentRegistrationToken handle)
	Unregister content producer.
bool	updateData (ContentRegistrationToken handle, const string &stream, const string &path)
	Updates the data of a specific registration.
bool	updateDataForPath (ContentRegistrationToken handle, const string &path)
	Updates the data of specific registration and especially a specified path within it.
ServiceRuntimeDataRegistry::ContentRegistrationToken	updateSchema (ContentRegistrationToken token, const string &schema)
	Updates the schema at runtime.
ContentRegistrationToken	updateSchema (ContentRegistrationToken token, RuntimeDataObjectSharedPtr dataRoot, const string &schema)
	Changes the runtime data schema.
Public Member Functions inherited from kanzi::connect::VirtualFileProvider
virtual void	cancelAllPendingRequests ()
virtual	~VirtualFileProvider ()
	Virtual destructor for cleanup.

Public Attributes
bool	m_active
	True if data should be distributed.
DiagnosticsManagerSharedPtr	m_diagnostics
	Diagnostics manager.
ConnectDomainSharedPtr	m_domain
	The domain.
VirtualFileLocalClientSharedPtr	m_HTTPClient
	HTTP Client for HTTP Communications.
VirtualFileClient::RegistrationToken	m_HTTPSchemaToken
	HTTP Schema token.
VirtualFileClient::RegistrationToken	m_HTTPToken
	HTTP registration token.

Protected Member Functions
virtual void	provideFile (const string &path, VirtualFileResponseSharedPtr response) override
	Invoked when there is a requirement to provide a file.

Detailed Description

Encapsulates service runtime data.

Member Typedef Documentation

ContentRegistrationToken

typedef shared_ptr<void> kanzi::connect::ServiceRuntimeDataRegistry::ContentRegistrationToken

ContentSubscriptionToken

typedef shared_ptr<void> kanzi::connect::ServiceRuntimeDataRegistry::ContentSubscriptionToken

RuntimeContentUpdateCallback

typedef function<void(const string&, const string&) kanzi::connect::ServiceRuntimeDataRegistry::RuntimeContentUpdateCallback)

Constructor & Destructor Documentation

ServiceRuntimeDataRegistry()

kanzi::connect::ServiceRuntimeDataRegistry::ServiceRuntimeDataRegistry	(	ConnectDomainSharedPtr	domain = nullptr,
		DiagnosticsManagerSharedPtr	diagnostics = DiagnosticsManagerSharedPtr() )

C++ constructor.

Parameters

domain	the connect domain (optional)
diagnostics	diagnostics functionality for traffic logging etc.

Member Function Documentation

getRootObjectForRegistration()

RuntimeDataObjectSharedPtr kanzi::connect::ServiceRuntimeDataRegistry::getRootObjectForRegistration

(

ContentRegistrationToken

token

)

Retrieves the root object associated with the specific content registration token.

Parameters

token

the content registration token

Returns

shared pointer to root node. Should not ever be empty pointer.

getRootObjectForSubscription()

RuntimeDataObjectSharedPtr kanzi::connect::ServiceRuntimeDataRegistry::getRootObjectForSubscription

(

ContentSubscriptionToken

token

)

Retrieves the root object associated with the specific content listener token.

Parameters

token

the token to query

Returns

shared pointer to root node. Can be empty pointer.

getSchemaForSubscription()

const string kanzi::connect::ServiceRuntimeDataRegistry::getSchemaForSubscription

(

ContentSubscriptionToken

token

)

Retrieve XML format schema for content subscription.

Parameters

token

identifies the subscription

Returns

XML format schema. Or empty string if unable to retrieve.

initializeHTTP()

void kanzi::connect::ServiceRuntimeDataRegistry::initializeHTTP

(

)

Initializes HTTP Functionality.

Must be called after HTTP Functionality itself has been initialized.

provideFile()

virtual void kanzi::connect::ServiceRuntimeDataRegistry::provideFile ( const string & path, VirtualFileResponseSharedPtr response )

overrideprotectedvirtual

Invoked when there is a requirement to provide a file.

Parameters

path	requested path.
response	the response object that is to be completed within the callback. Object must not be stored by called entity.

Implements kanzi::connect::VirtualFileProvider.

registerContentListener()

ContentSubscriptionToken kanzi::connect::ServiceRuntimeDataRegistry::registerContentListener	(	const string &	path,
		RuntimeContentUpdateCallback	callback )

Registers runtime content listener to a specific path.

Parameters

path	where to register.

Returns

handle that can later on be used to unregister content listener.

registerContentProducer() [1/2]

ContentRegistrationToken kanzi::connect::ServiceRuntimeDataRegistry::registerContentProducer	(	const string &	servicename,
		const string &	xml )

Registers a content producer from XML schema definition.

This is used with remote services.

Parameters

servicename	name of the service
xml	xml contents

Returns

handle to object that can later on be used to.

registerContentProducer() [2/2]

ContentRegistrationToken kanzi::connect::ServiceRuntimeDataRegistry::registerContentProducer	(	const string &	servicename,
		RuntimeDataObjectSharedPtr	dataRoot,
		const string &	schema )

Registers a content producer, aka a service.

Parameters

servicename	The name of the service.
dataRoot	The root object.

Returns

handle to object that can later on be used to.

renameContentProducer()

bool kanzi::connect::ServiceRuntimeDataRegistry::renameContentProducer	(	const string &	oldname,
		const string &	newname )

Renames a content producer.

Required for example by simulator when service models name is changed

Parameters

oldname	the old name.
newname	the new name.

Returns

true if succeeded, false otherwise.

uninitializeHTTP()

void kanzi::connect::ServiceRuntimeDataRegistry::uninitializeHTTP

(

)

Uninitialize HTTP Functionality.

unregisterContentListener()

void kanzi::connect::ServiceRuntimeDataRegistry::unregisterContentListener

(

ContentSubscriptionToken

token

)

Unregisters content listener.

Parameters

token

what to unregister.

unregisterContentProducer()

void kanzi::connect::ServiceRuntimeDataRegistry::unregisterContentProducer

(

ContentRegistrationToken

handle

)

Unregister content producer.

Parameters

handle

the handle of operation

updateData()

bool kanzi::connect::ServiceRuntimeDataRegistry::updateData	(	ContentRegistrationToken	handle,
		const string &	stream,
		const string &	path )

Updates the data of a specific registration.

Parameters

handle	identifies the updated, earlier returned by registerContentProducer
stream	the serialized update content.
path	the path that was reported to be changed.

Returns

true if update took place.

updateDataForPath()

bool kanzi::connect::ServiceRuntimeDataRegistry::updateDataForPath	(	ContentRegistrationToken	handle,
		const string &	path )

Updates the data of specific registration and especially a specified path within it.

Parameters

handle	identifies the updated, earlier returned by registerContentProducer
path	the path that changed.

Returns

true if update took place.

updateSchema() [1/2]

ServiceRuntimeDataRegistry::ContentRegistrationToken kanzi::connect::ServiceRuntimeDataRegistry::updateSchema	(	ContentRegistrationToken	token,
		const string &	schema )

Updates the schema at runtime.

Parameters

token	identifies the content registration
schema	new xml definition of the data

Returns

handle to new registration.

updateSchema() [2/2]

ContentRegistrationToken kanzi::connect::ServiceRuntimeDataRegistry::updateSchema	(	ContentRegistrationToken	token,
		RuntimeDataObjectSharedPtr	dataRoot,
		const string &	schema )

Changes the runtime data schema.

Parameters

token	the token that identifies the previously registered content producer
dataRoot	the root object.
schema	the xml schema that defines the new structure.

Member Data Documentation

m_active

bool kanzi::connect::ServiceRuntimeDataRegistry::m_active

True if data should be distributed.

m_diagnostics

DiagnosticsManagerSharedPtr kanzi::connect::ServiceRuntimeDataRegistry::m_diagnostics

Diagnostics manager.

m_domain

ConnectDomainSharedPtr kanzi::connect::ServiceRuntimeDataRegistry::m_domain

The domain.

m_HTTPClient

VirtualFileLocalClientSharedPtr kanzi::connect::ServiceRuntimeDataRegistry::m_HTTPClient

HTTP Client for HTTP Communications.

m_HTTPSchemaToken

VirtualFileClient::RegistrationToken kanzi::connect::ServiceRuntimeDataRegistry::m_HTTPSchemaToken

HTTP Schema token.

m_HTTPToken

VirtualFileClient::RegistrationToken kanzi::connect::ServiceRuntimeDataRegistry::m_HTTPToken

HTTP registration token.

---

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

• connect/runtimedata/serviceruntimedataregisterer.hpp