guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
event_subscriber.hpp
1/*
2 Copyright (c) 2026 ETIB Corporation
3
4 Permission is hereby granted, free of charge, to any person obtaining a copy of
5 this software and associated documentation files (the "Software"), to deal in
6 the Software without restriction, including without limitation the rights to
7 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
8 of the Software, and to permit persons to whom the Software is furnished to do
9 so, subject to the following conditions:
10
11 The above copyright notice and this permission notice shall be included in all
12 copies or substantial portions of the Software.
13
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 SOFTWARE.
21 */
22
23#pragma once
24
25#include <memory>
26#include <queue>
27
28#include "guillaume/event/event_bus.hpp"
29#include <utility/event/event.hpp>
30
31namespace guillaume::event
32{
33
58 template<utility::event::InheritFromEvent EventType> class EventSubscriber
59 {
60 private:
61 std::queue<std::shared_ptr<EventType>>
62 _eventQueue;
64
65 public:
72
77 ~EventSubscriber(void) = default;
78
83 bool hasPendingEvents(void) const;
84
89 std::shared_ptr<EventType> getNextEvent(void);
90 };
91
92} // namespace guillaume::event
93
94// Include the implementation of the EventSubscriber template class
95#include "guillaume/event/event_subscriber.tpp"
Hands each engine event to the listeners subscribed to its type.
Definition event_bus.hpp:67
EventSubscriber(EventBus &eventBus)
Create an empty queue and subscribe it to a bus.
bool hasPendingEvents(void) const
Tell whether at least one event is waiting.
std::shared_ptr< EventType > getNextEvent(void)
Take the oldest waiting event out of the queue.
~EventSubscriber(void)=default
Destroy the queue. The bus is not told: see the note of the class.
Delivery of engine events to the systems that subscribed to them.
Definition event_bus.hpp:34