NebulaStream  0.6.213
NebulaStream is a data and application management framework for the internet of things
NES::DataEmitter Class Referenceabstract

Interface that classes have to adhere to emit data as tasks. More...

#include <DataEmitter.hpp>

Collaboration diagram for NES::DataEmitter:
[legend]

Public Member Functions

virtual void emitWork (Runtime::TupleBuffer &buffer, bool addBufferMetaData=true)=0
 create a task using the provided buffer and submit it to a task consumer, e.g., query manager More...
 
virtual ~DataEmitter () NES_NOEXCEPT(false)=default
 
virtual void onEndOfStream (Runtime::QueryTerminationType)
 
virtual void onEvent (Runtime::BaseEvent &) override
 API method called upon receiving an event. More...
 
virtual DecomposedQueryPlanVersion getVersion () const
 
virtual bool startNewVersion ()
 start a previously scheduled new version for this data emitter More...
 
virtual bool insertReconfigurationMarker (ReconfigurationMarkerPtr)
 check if a reconfiguration marker contains an event for this data emitter. If so, trigger the reconfiguration and propagate the marker downstream. More...
 
- Public Member Functions inherited from NES::detail::virtual_enable_shared_from_this< RuntimeEventListener, false >
 ~virtual_enable_shared_from_this () NES_NOEXCEPT(isNoexceptDestructible) override=default
 
std::shared_ptr< T1 > shared_from_this ()
 
std::weak_ptr< T1 > weak_from_this ()
 
- Public Member Functions inherited from NES::detail::virtual_enable_shared_from_this_base< isNoexceptDestructible >
virtual ~virtual_enable_shared_from_this_base () NES_NOEXCEPT(isNoexceptDestructible)=default
 

Additional Inherited Members

Detailed Description

Interface that classes have to adhere to emit data as tasks.

Constructor & Destructor Documentation

◆ ~DataEmitter()

virtual NES::DataEmitter::~DataEmitter ( )
virtualdefault

Member Function Documentation

◆ emitWork()

virtual void NES::DataEmitter::emitWork ( Runtime::TupleBuffer buffer,
bool  addBufferMetaData = true 
)
pure virtual

create a task using the provided buffer and submit it to a task consumer, e.g., query manager

Parameters
buffer
addBufferMetaDataIf true, buffer meta data (e.g., sequence number, statistic id, origin id, ...) is added to the buffer

Implemented in NES::DataSource.

◆ getVersion()

virtual DecomposedQueryPlanVersion NES::DataEmitter::getVersion ( ) const
inlinevirtual

Reimplemented in NES::Network::NetworkSource.

References NES_WARNING.

◆ insertReconfigurationMarker()

virtual bool NES::DataEmitter::insertReconfigurationMarker ( ReconfigurationMarkerPtr  )
inlinevirtual

check if a reconfiguration marker contains an event for this data emitter. If so, trigger the reconfiguration and propagate the marker downstream.

Parameters
markera marker containing a set of reconfiguration events
Returns
true if a reconfiguration was triggered, false if the marker did not contain any event to be handled by this data emitter

Reimplemented in NES::Network::NetworkSource.

◆ onEndOfStream()

virtual void NES::DataEmitter::onEndOfStream ( Runtime::QueryTerminationType  )
inlinevirtual

Reimplemented in NES::Network::NetworkSource.

◆ onEvent()

virtual void NES::DataEmitter::onEvent ( Runtime::BaseEvent event)
inlineoverridevirtual

API method called upon receiving an event.

Parameters
event

Implements NES::Runtime::RuntimeEventListener.

Reimplemented in NES::Network::NetworkSource, NES::DataSource, and NES::Experimental::StaticDataSource.

Referenced by NES::DataSource::onEvent().

Here is the caller graph for this function:

◆ startNewVersion()

virtual bool NES::DataEmitter::startNewVersion ( )
inlinevirtual

start a previously scheduled new version for this data emitter

Reimplemented in NES::Network::NetworkSource.


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