NES::Runtime::CustomEventWrapper Class Reference

This class shall be used to define custom events with user-supplied data. More...

#include <Events.hpp>

Collaboration diagram for NES::Runtime::CustomEventWrapper:

Public Member Functions
	CustomEventWrapper (Runtime::TupleBuffer &&buffer)
	creates a custom events that stores a buffer as a payload More...
uint8_t *	data () override
	Gets the payload of the event. More...
template<typename T >
T *	data ()
	Gets the payload of the event. More...
Public Member Functions inherited from NES::Runtime::BaseEvent
	BaseEvent (EventType eventType=EventType::kInvalidEvent)
	Creates an event of a given type. More...
EventType	getEventType () const
	The event type. More...

Detailed Description

This class shall be used to define custom events with user-supplied data.

Constructor & Destructor Documentation

CustomEventWrapper()

NES::Runtime::CustomEventWrapper::CustomEventWrapper ( Runtime::TupleBuffer &&  buffer )

inlineexplicit

creates a custom events that stores a buffer as a payload

Parameters

buffer

References NES::Runtime::kCustomEvent.

Member Function Documentation

data() [1/2]

template<typename T >

T* NES::Runtime::CustomEventWrapper::data ( )

inlinevirtual

Gets the payload of the event.

Returns

the payload of the event

Implements NES::Runtime::BaseEvent.

References NES::Runtime::TupleBuffer::getBuffer().

Here is the call graph for this function:

data() [2/2]

uint8_t* NES::Runtime::CustomEventWrapper::data ( )

inlineoverridevirtual

Gets the payload of the event.

Returns

the payload of the event

Implements NES::Runtime::BaseEvent.

References NES::Runtime::TupleBuffer::getBuffer().

Here is the call graph for this function:

---

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

• /nebulastream/nes-runtime/include/Runtime/Events.hpp