coreflow::EventQueue Class Reference

#include <vx_event_queue.hpp>

Public Member Functions
	EventQueue (bool enabled=false, size_t max_size=128)
	Construct a new Event Queue object.
void	clear ()
	Clear the event queue.
vx_status	status (bool status)
	Update the event queue status.
bool	isEnabled () const
	Check if the event queue is enabled.
vx_status	push (vx_event_type_e type, vx_uint32 data=0, vx_event_info_t *info=nullptr, vx_reference ref=nullptr)
	Push an event to the queue.
vx_status	push (vx_event_t event)
	Push an event to the queue.
vx_status	wait (vx_event_t *event, vx_bool do_not_block)
vx_status	registerEvent (vx_reference ref, vx_event_type_e type, vx_uint32 param, vx_uint32 app_value)

Constructor & Destructor Documentation

EventQueue()

coreflow::EventQueue::EventQueue ( bool enabled = false, size_t max_size = 128 )

inlineexplicit

Construct a new Event Queue object.

Parameters

enabled
max_size

Member Function Documentation

clear()

void coreflow::EventQueue::clear ( )

inline

Clear the event queue.

isEnabled()

bool coreflow::EventQueue::isEnabled ( ) const

inline

Check if the event queue is enabled.

Returns

true if enabled

false if disabled

push() [1/2]

vx_status coreflow::EventQueue::push ( vx_event_t event )

inline

Push an event to the queue.

Parameters

event

Event to push

Returns

true if successful

false if failed

push() [2/2]

vx_status coreflow::EventQueue::push ( vx_event_type_e type, vx_uint32 data = 0, vx_event_info_t * info = nullptr, vx_reference ref = nullptr )

inline

Push an event to the queue.

Parameters

type	Event type
data	Optional event value
info	Optional event info pointer
ref	Optional vx_reference used to look up additional registration data

Returns

true if successful

false if failed

registerEvent()

vx_status coreflow::EventQueue::registerEvent ( vx_reference ref, vx_event_type_e type, vx_uint32 param, vx_uint32 app_value )

inline

status()

vx_status coreflow::EventQueue::status ( bool status )

inline

Update the event queue status.

Parameters

status

true to enable, false to disable

wait()

vx_status coreflow::EventQueue::wait ( vx_event_t * event, vx_bool do_not_block )

inline