Implements abstract base class for data source type that is able to transform Kanzi Connect database query to data object tree. More...

#include <abstract_connect_datasource.hpp>

Inheritance diagram for kanzi::connect::AbstractConnectDataSource:

Public Member Functions
	KZ_METACLASS_END ()

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) KZ_OVERRIDE

void	start ()
	Starts operation. More...

void	stop ()
	Stops operation. More...

virtual	~AbstractConnectDataSource () KZ_OVERRIDE
	Destructor. More...


virtual DataObjectSharedPtr	getData () KZ_OVERRIDE

virtual void	loadFromKZB (Domain *domain, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser) KZ_OVERRIDE

virtual void	loadFromKZB (const KzuResourceLoaderThreadContext threadContext, KzcInputStream inputStream, const KzuBinaryFileInfo *file) KZ_OVERRIDE

virtual void	unloadOverride () KZ_OVERRIDE

Public Member Functions inherited from kanzi::connect::ContentAdapterManager
void	addAdapter (ContentAdapterSharedPtr adapter)
	Adds new adapter to list of adapters, but does not set up or start it. More...

	ContentAdapterManager (ContextSharedPtr context, DataSource *dataSource)
	Constructor. More...

	ContentAdapterManager (DataSource *dataSource)
	Constructor. More...

virtual ContentAdapterSharedPtr	createAdapter (const string &serverName, const ContentAdapterConfigurationSharedPtr config, Domain *domain)
	Creates a standard adapter. More...

void	destroyAllAdapters ()
	Stops and cleans up all adapters. More...

ContentAdapterSharedPtr	findDynamicSource (const string &name)
	Locates a dynamic source with given name. More...

ContentAdapterSharedPtr	findSource (const string &name)
	Locates a source with given name. More...

ContentAdapterManager::AdapterContainer	getAdapters ()
	Retrieves all currently known adapters. More...

ContextSharedPtr	getContext () const
	Returns gateway to Kanzi Connect server. More...

void	initializeAllAdapters (DataObjectSharedPtr root)
	Initializes all adapters. More...

void	removeAdapter (ContentAdapterSharedPtr adapter)
	Removes adapter from list of adapters. More...

void	setContext (ContextSharedPtr context)
	Set gateway to Kanzi Connect server. More...

virtual ContentAdapterSharedPtr	startAdapter (const string &serverName, DataObjectSharedPtr root, const ContentAdapterConfigurationSharedPtr config)
	Instantiates and starts new adapter according to given parameters. More...

void	startAllAdapters ()
	Starts all adapters. More...

virtual void	stopAdapter (ContentAdapterSharedPtr adapter)
	Stops an existing adapter. More...

void	stopAllAdapters ()
	Stops all existing adapters. More...

virtual	~ContentAdapterManager ()=default
	dtor More...

Static Public Attributes
static PropertyType< string >	ServerNameProperty

static PropertyType< bool >	ServiceEnabledProperty

static PropertyType< string >	ServiceIdentifierProperty

name Name of the data source.

Constructor.

Parameters

domain Kanzi UI Domain.

AbstractConnectDataSource (kanzi::Domain *domain, kanzi::string_view name)

void onConnectionStateChanged (Connection::State state)

Callback for connection state changes. More...

virtual void onCreateAdapters ()=0

Derived class needs to implement this in order to populate adapters for this data source. More...

virtual void onReleaseAdapters ()

Derived class needs to implement this in order to release adapters of this data source. More...

bool isConnected () const

Check if this data source is connected to server. More...

Additional Inherited Members
Public Types inherited from kanzi::connect::ContentAdapterManager
typedef vector< ContentAdapterSharedPtr >	AdapterContainer

Protected Attributes inherited from kanzi::connect::ContentAdapterManager
DataSource *	m_dataSource
	The instance which owns the data objects managed by content adapters. More...

Detailed Description

Implements abstract base class for data source type that is able to transform Kanzi Connect database query to data object tree.

Constructor & Destructor Documentation

◆ ~AbstractConnectDataSource()

virtual kanzi::connect::AbstractConnectDataSource::~AbstractConnectDataSource ( )

virtual

Destructor.

◆ AbstractConnectDataSource()

kanzi::connect::AbstractConnectDataSource::AbstractConnectDataSource	(	kanzi::Domain *	domain,
		kanzi::string_view	name
	)

explicitprotected

Member Function Documentation

◆ getData()

virtual DataObjectSharedPtr kanzi::connect::AbstractConnectDataSource::getData ( )

virtual

See also: kanzi::DataSource

◆ isConnected()

bool kanzi::connect::AbstractConnectDataSource::isConnected ( ) const

protected

Check if this data source is connected to server.

Returns: True, if connected to server, otherwise false.

◆ KZ_METACLASS_END()

kanzi::connect::AbstractConnectDataSource::KZ_METACLASS_END ( )

◆ loadFromKZB() [1/2]

virtual void kanzi::connect::AbstractConnectDataSource::loadFromKZB	(	Domain *	domain,
		KzbFile &	kzbFile,
		ReadOnlyMemoryFile &	file,
		KzbMemoryParser &	parser
	)

virtual

◆ loadFromKZB() [2/2]

virtual void kanzi::connect::AbstractConnectDataSource::loadFromKZB	(	const KzuResourceLoaderThreadContext *	threadContext,
		KzcInputStream *	inputStream,
		const KzuBinaryFileInfo *	file
	)

virtual

◆ onConnectionStateChanged()

void kanzi::connect::AbstractConnectDataSource::onConnectionStateChanged ( Connection::State state )

protected

Callback for connection state changes.

Parameters

state The new state of the connection.

◆ onCreateAdapters()

virtual void kanzi::connect::AbstractConnectDataSource::onCreateAdapters ( )

protectedpure virtual

Derived class needs to implement this in order to populate adapters for this data source.

Implemented in kanzi::connect::KanziConnectDataSource.

◆ onPropertyChanged()

virtual void kanzi::connect::AbstractConnectDataSource::onPropertyChanged	(	AbstractPropertyType	propertyType,
		PropertyNotificationReason	reason
	)

virtual

See also: PropertyObject::onPropertyChanged

◆ onReleaseAdapters()

virtual void kanzi::connect::AbstractConnectDataSource::onReleaseAdapters ( )

inlineprotectedvirtual

Derived class needs to implement this in order to release adapters of this data source.

Reimplemented in kanzi::connect::KanziConnectDataSource.

◆ start()

void kanzi::connect::AbstractConnectDataSource::start ( )

Starts operation.

◆ stop()

void kanzi::connect::AbstractConnectDataSource::stop ( )

Stops operation.

◆ unloadOverride()

virtual void kanzi::connect::AbstractConnectDataSource::unloadOverride ( )

virtual

Member Data Documentation

◆ ServerNameProperty

PropertyType<string> kanzi::connect::AbstractConnectDataSource::ServerNameProperty

static

◆ ServiceEnabledProperty

PropertyType<bool> kanzi::connect::AbstractConnectDataSource::ServiceEnabledProperty

static

◆ ServiceIdentifierProperty

PropertyType<string> kanzi::connect::AbstractConnectDataSource::ServiceIdentifierProperty

static

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

connect/kanzi_adaptation/datasource/abstract_connect_datasource.hpp

Public Member Functions

Static Public Attributes

name Name of the data source.

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~AbstractConnectDataSource()

◆ AbstractConnectDataSource()

Member Function Documentation

◆ getData()

◆ isConnected()

◆ KZ_METACLASS_END()

◆ loadFromKZB() [1/2]

◆ loadFromKZB() [2/2]

◆ onConnectionStateChanged()

◆ onCreateAdapters()

◆ onPropertyChanged()

◆ onReleaseAdapters()

◆ start()

◆ stop()

◆ unloadOverride()

Member Data Documentation

◆ ServerNameProperty

◆ ServiceEnabledProperty

◆ ServiceIdentifierProperty