This is the base event type. All events supported in NES shall inherit from this class. More...

#include <Events.hpp>

Public Member Functions
	BaseEvent (EventType eventType=EventType::kInvalidEvent)
	Creates an event of a given type. More...

virtual uint8_t *	data ()=0
	Gets the payload of the event. More...

EventType	getEventType () const
	The event type. More...

Detailed Description

This is the base event type. All events supported in NES shall inherit from this class.

Design rationale: create an own event that inherits from BaseEvent for internal system events (e.g., the checkpoint barrier, the upstream ACK). Use the custom event for user-specific events, e.g., feedback loops for toggling source sampling frequency.

Constructor & Destructor Documentation

◆ BaseEvent()

NES::Runtime::BaseEvent::BaseEvent ( EventType eventType = EventType::kInvalidEvent )

inlineexplicit

Creates an event of a given type.

Parameters

eventType

Member Function Documentation

◆ data()

virtual uint8_t* NES::Runtime::BaseEvent::data ( )

pure virtual

Gets the payload of the event.

Returns: the payload of the event

Implemented in NES::Runtime::StartSourceEvent, NES::Runtime::CustomEventWrapper, and NES::Runtime::CustomEventWrapper.

◆ getEventType()

EventType NES::Runtime::BaseEvent::getEventType ( ) const

inline

The event type.

Returns

Referenced by NES::Experimental::StaticDataSource::onEvent(), NES::Network::NetworkSink::onEvent(), NES::Runtime::Execution::ExecutablePipeline::onEvent(), and NES::Network::NetworkSource::onEvent().

Here is the caller graph for this function:

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