EventManager Class Reference

Manages the system-wide event queue and subscriptions. More...

#include <EventManager.h>

Collaboration diagram for EventManager:

Classes
struct	Subscriber

Public Member Functions
	EventManager (size_t queueSize=0)
	Constructor with optional queue size override.
void	subscribe (uint32_t eventMask, FrameworkController *controller)
	Subscribe a task to specific event types.
void	postEvent (const Event &e)
	Post a notification to the queue and notify matching subscribers.
void	postNotification (const Notification &n, FrameworkTask *target)
	Post a notification to the queue and notify matching subscribers.
void	enqueue (const Event &event)
	Post an event to the queue and notify matching subscribers.
bool	hasPendingEvents (FrameworkController *controller) const
	Returns true if there are any pending events for a given controller.
template<typename Enum , typename... Rest>
void	subscribeTo (FrameworkController *ctrl, Enum first, Rest... rest)

Static Public Member Functions
static EventManager &	getInstance ()
	Get the global EventManager instance.

Private Member Functions
void	withSubscribers (const std::function< void(std::vector< Subscriber > &)> &fn)
void	withSubscribersFromISR (const std::function< void(std::vector< Subscriber > &)> &fn)
	Provides read-only access to subscribers from ISR context (no locking).

Private Attributes
SemaphoreHandle_t	lock
std::vector< Subscriber >	subscribers_

Static Private Attributes
static StaticSemaphore_t	lockBuffer_

Detailed Description

Allows tasks to:

• Subscribe to specific event types (via bitmask)
• Post events (from task or ISR context)
• Receive and process events via onEvent()

Implemented as a singleton.

Definition at line 63 of file EventManager.h.

Constructor & Destructor Documentation

EventManager()

EventManager::EventManager ( size_t  queueSize = 0 )

explicit

Constructor with optional queue size override.

Parameters

queueSize

Maximum number of events in the internal queue.

Parameters

queueSize

Maximum number of events in the internal queue.

Definition at line 50 of file EventManager.cpp.

{
    lock = xSemaphoreCreateMutexStatic(&lockBuffer_);
    configASSERT(lock);
}

References configASSERT, lock, and lockBuffer_.

Member Function Documentation

enqueue()

void EventManager::enqueue

(

const Event &

event

)

Post an event to the queue and notify matching subscribers.

Safe to call from task or ISR context.

Parameters

event

The event to post.

Safe to call from task or ISR context.

Parameters

event

The event to post.

Definition at line 111 of file EventManager.cpp.

{
    const uint8_t code = event.notification.code();
 
    if (is_in_interrupt()) {
        BaseType_t xHigherPriTaskWoken = pdFALSE;
 
        withSubscribersFromISR([&](auto& subs) {
            for (auto& sub : subs) {
                if ((sub.eventMask & (1u << code)) &&
                    (event.target == nullptr || sub.controller == event.target))
                {
                    QueueHandle_t q = sub.controller->getEventQueue();
                    if (q) {
                        BaseType_t result = xQueueSendToBackFromISR(q, &event, &xHigherPriTaskWoken);
                        if (result != pdPASS) {
                            debug_print("[EventManager] xQueueSendFromISR FAILED — queue full!\n");
                        }
                    }
                }
            }
        });
 
        portYIELD_FROM_ISR(xHigherPriTaskWoken);
    } else {
        withSubscribers([&](auto& subs) {
            for (auto& sub : subs) {
                if ((sub.eventMask & (1u << code)) &&
                    (event.target == nullptr || sub.controller == event.target))
                {
                    QueueHandle_t q = sub.controller->getEventQueue();
                    if (q) {
                        if (xQueueSendToBack(q, &event, 0) != pdPASS) {
                            debug_print("[EventManager] xQueueSend FAILED — queue full!\n");
                        }
                    }
                }
            }
        });
    }
}

References debug_print(), is_in_interrupt(), withSubscribers(), and withSubscribersFromISR().

Referenced by postEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

getInstance()

static EventManager & EventManager::getInstance ( )

inlinestatic

Definition at line 69 of file EventManager.h.

    {
        static EventManager instance;
        return instance;
    }

hasPendingEvents()

bool EventManager::hasPendingEvents

(

FrameworkController *

controller

)

const

Parameters

controller

Pointer to the controller.

Returns

True if any matching events exist.

postEvent()

void EventManager::postEvent

(

const Event &

e

)

Safe to call from task or ISR context.

Parameters

n	The notification to post.
target	Optional specific controller to notify (nullptr for all).

Definition at line 153 of file EventManager.cpp.

{
    enqueue(e);
    postNotification(e.notification, e.target);
}

References enqueue(), Event::notification, postNotification(), and Event::target.

Here is the call graph for this function:

postNotification()

void EventManager::postNotification	(	const Notification &	n,
		FrameworkTask *	target
	)

Post a notification to the queue and notify matching subscribers.

Safe to call from task or ISR context.

Parameters

n	The notification to post.
target	Optional specific controller to notify (nullptr for all).

Safe to call from task or ISR context.

Parameters

n	The notification to post.
target	Optional specific controller to notify (nullptr for all).

Definition at line 80 of file EventManager.cpp.

{
    const uint8_t index = n.code();
 
    if (is_in_interrupt()) {
        BaseType_t xHigherPriTaskWoken = pdFALSE;
 
        withSubscribersFromISR([&](auto& subs) {
            for (auto& sub : subs) {
                if ((sub.eventMask & (1u << index)) &&
                    (target == nullptr || sub.controller == target)) {
                    sub.controller->notifyFromISR(index, 1, &xHigherPriTaskWoken);
                }
            }
        });
 
        portYIELD_FROM_ISR(xHigherPriTaskWoken);
    } else {
        withSubscribers([&](auto& subs) {
            for (auto& sub : subs) {
                if ((sub.eventMask & (1u << index)) &&
                    (target == nullptr || sub.controller == target)) {
                    sub.controller->notify(index, 1);
                }
            }
        });
    }
}

References Notification::code(), is_in_interrupt(), withSubscribers(), and withSubscribersFromISR().

Referenced by postEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

subscribe()

void EventManager::subscribe	(	uint32_t	mask,
		FrameworkController *	target
	)

Subscribe a task to specific event types.

Each controller provides a bitmask of events it is interested in.

Parameters

eventMask	Bitmask of (1 << event.notification.code()).
controller	Pointer to the FrameworkController to notify.

Note

All EventManager::subscribe() for thread safety, calls must complete before interrupts are enabled."

Each controller provides a bitmask of events it is interested in.

Parameters

eventMask	Bitmask of (1 << event.notification.code()).
controller	Pointer to the FrameworkController to notify.

Note

All EventManager::subscribe() for thread safety, calls must complete before interrupts are enabled."

Definition at line 57 of file EventManager.cpp.

{
    withSubscribers([&](auto& subs) {
        subs.push_back({mask, target});
    });
}

References withSubscribers().

Referenced by App::onStart(), and subscribeTo().

Here is the call graph for this function:

Here is the caller graph for this function:

subscribeTo()

template<typename Enum , typename... Rest>

void EventManager::subscribeTo ( FrameworkController *  ctrl, Enum  first, Rest...  rest  )

inline

Definition at line 132 of file EventManager.h.

                                                                                 {
        static_assert(
            (std::is_same_v<Enum, Rest> && ...),
            "All event types must be of the same enum class (UserNotification or SystemNotification)"
        );
    
        subscribe(eventMask(first, rest...), ctrl);
    }

References eventMask(), and subscribe().

Here is the call graph for this function:

withSubscribers()

void EventManager::withSubscribers ( const std::function< void(std::vector< Subscriber > &)> &  fn )

private

Definition at line 64 of file EventManager.cpp.

{
    xSemaphoreTake(lock, portMAX_DELAY);
    fn(subscribers_);
    xSemaphoreGive(lock);
}

References lock, and subscribers_.

Referenced by enqueue(), postNotification(), and subscribe().

Here is the caller graph for this function:

withSubscribersFromISR()

void EventManager::withSubscribersFromISR ( const std::function< void(std::vector< Subscriber > &)> &  fn )

private

Provides read-only access to subscribers from ISR context (no locking).

WARNING: Call only from ISR context. Must not modify the list.

WARNING: Call only from ISR context. Must not modify the list.

Definition at line 72 of file EventManager.cpp.

{
    xSemaphoreTake(lock, portMAX_DELAY);
    fn(subscribers_);
    xSemaphoreGive(lock);
}

References lock, and subscribers_.

Referenced by enqueue(), and postNotification().

Here is the caller graph for this function:

Member Data Documentation

lock

SemaphoreHandle_t EventManager::lock

private

Definition at line 148 of file EventManager.h.

Referenced by EventManager(), withSubscribers(), and withSubscribersFromISR().

lockBuffer_

StaticSemaphore_t EventManager::lockBuffer_

staticprivate

Definition at line 149 of file EventManager.h.

Referenced by EventManager().

subscribers_

std::vector<Subscriber> EventManager::subscribers_

private

Definition at line 151 of file EventManager.h.

Referenced by withSubscribers(), and withSubscribersFromISR().

---

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

• EventManager.h
• EventManager.cpp