Uniot Core
0.8.1
Loading...
Searching...
No Matches
EventListener.h
Go to the documentation of this file.
1/*
2 * This is a part of the Uniot project.
3 * Copyright (C) 2016-2023 Uniot <contact@uniot.io>
4 *
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 */
18
19#pragma once
20
21#include <Bytes.h>
22#include <ClearQueue.h>
23#include <IterableQueue.h>
24
25#include "EventEmitter.h"
26
27namespace uniot {
41template <class T_topic, class T_msg, class T_data>
42class EventListener : public EventEmitter<T_topic, T_msg, T_data> {
43 public:
47 virtual ~EventListener() = default;
48
53 virtual type_id getTypeId() const override {
55 }
56
63
70
77 bool isListeningToEvent(T_topic topic);
78
88 virtual void onEventReceived(T_topic topic, T_msg msg) = 0;
89
90 private:
92 ClearQueue<T_topic> mTopics;
93};
94
102} // namespace uniot
Definition ClearQueue.h:38
Definition EventEmitter.h:41
Definition EventListener.h:42
EventListener * stopListeningToEvent(T_topic topic)
Unsubscribe from events of a specific topic.
Definition EventListener.cpp:33
virtual void onEventReceived(T_topic topic, T_msg msg)=0
Handler called when an event is received.
bool isListeningToEvent(T_topic topic)
Check if this listener is subscribed to a specific topic.
Definition EventListener.cpp:39
virtual type_id getTypeId() const override
Get the type ID of this class for RTTI.
Definition EventListener.h:53
virtual ~EventListener()=default
Virtual destructor.
EventListener * listenToEvent(T_topic topic)
Subscribe to events of a specific topic.
Definition EventListener.cpp:27
static type_id getTypeId()
Get the unique type identifier for a given type T.
Definition TypeId.h:82
EventListener< unsigned int, int, Bytes > CoreEventListener
Type alias for the common EventListener configuration used in the core system.
Definition EventListener.h:100
const void * type_id
Type alias for a unique type identifier.
Definition TypeId.h:43
Contains all classes and functions related to the Uniot Core.