Skip to content

Class jac::EventQueueFeature

template <class Next class Next>

ClassList > jac > EventQueueFeature

Inherits the following classes: Next

Public Functions

Type Name
std::optional< std::function< void()> > getEvent (bool wait)
Check the event queue and return the first event.
void notifyEventLoop ()
Wake up event loop if it is waiting for events.
void scheduleEvent (std::function< void()> func)
Schedule an event to be run.
~EventQueueFeature ()

Public Functions Documentation

function getEvent

Check the event queue and return the first event.

inline std::optional< std::function< void()> > jac::EventQueueFeature::getEvent (
    bool wait
) 

Parameters:

  • wait Wait for event if no event is available

Returns:

Event or std::nullopt if no event is available

function notifyEventLoop

inline void jac::EventQueueFeature::notifyEventLoop () 

function scheduleEvent

Schedule an event to be run.

inline void jac::EventQueueFeature::scheduleEvent (
    std::function< void()> func
) 

Parameters:

  • func Function to be run

function ~EventQueueFeature

inline jac::EventQueueFeature::~EventQueueFeature () 

The documentation for this class was generated from the following file src/jac/features/eventQueueFeature.h