KafkaDataProvider::KafkaConsumerDataProvider Class Reference

Event-based data provider for Kafka events. More...

#include <KafkaConsumerDataProvider.qc.dox.h>

Inheritance diagram for KafkaDataProvider::KafkaConsumerDataProvider:

Public Member Methods
	constructor (KafkaConnection conn, *hash< auto > options)
	Creates the object from a connection object.
hash< DataProvider::DataProviderInfo >	getStaticInfoImpl ()
	Returns data provider static info.
	observersReady ()
	Called when all observers have been added to the object.
	stopEvents ()
	Called to stop generating events.
	update (string event_id, hash< auto > data_)
	This method is called when an event is raised.
Public Member Methods inherited from KafkaDataProvider::KafkaDataProviderBase
	constructor (KafkaConnection conn)
	Creates the object from a connection object.

Public Attributes
const	ProviderInfo = ...
	Provider info.
const	ConstructorOptions = ...
	Constructor options.
const	EVENT_KAFKA_MESSAGE = "kafka-message"
	Kafka message event constant.

Private Member Methods
hash< string, hash< DataProviderMessageInfo > >	getEventTypesImpl ()
	Returns a hash of all supported event types.

Detailed Description

Event-based data provider for Kafka events.

Member Function Documentation

getEventTypesImpl()

hash< string, hash< DataProviderMessageInfo > > KafkaDataProvider::KafkaConsumerDataProvider::getEventTypesImpl ( )

private

Returns a hash of all supported event types.

Returns

a hash of all supported event types

Note

only called if the provider supports the observer pattern / event API

observersReady()

KafkaDataProvider::KafkaConsumerDataProvider::observersReady

(

)

Called when all observers have been added to the object.

This method is meant to trigger event generation

stopEvents()

KafkaDataProvider::KafkaConsumerDataProvider::stopEvents

(

)

Called to stop generating events.

Stops polling for new events

update()

KafkaDataProvider::KafkaConsumerDataProvider::update	(	string	event_id,
		hash< auto >	data_
	)

This method is called when an event is raised.

Parameters

event_id	unique ID identifying an event type or class
data_	the data generated by the Observable event source

---

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

• doxygen/qlib/KafkaDataProvider/KafkaConsumerDataProvider.qc.dox.h