ADD: Adds class comments for Event, Manager and Participant.

This commit is contained in:
Christina Sander 2022-09-22 13:39:33 +02:00
parent d268273e3c
commit 01b2d3cd0d
Signed by untrusted user: csander
GPG Key ID: F0B2F0D577D7885B
3 changed files with 33 additions and 6 deletions

View File

@ -22,7 +22,13 @@
/// Eventtype to notify all participants that a shutdown is immanent
const static std::uint32_t EVENT_TYPE_SHUTDOWN = 0;
/**
* @class Event
* @brief An Event is the element in the system that triggers actions from participants
*
* Derive own events from this class to sned e.g. also a payload to subscribing
* participants.
*/
class Event
{
private:
@ -45,17 +51,17 @@
/**
* @brief constructor for creating a simple event
*
* @param type - what kinf of event is this
* @param type - what kind of event is this
*/
Event(std::uint32_t type);
/**
* @brief Constructor to create a response Event
* @brief Constructor to create a response event
*/
Event(std::uint32_t type, const EventManager::Event &event);
/**
* @brief Constructor to create a response Event
* @brief Constructor to create a response event
*/
Event(std::uint32_t type, const std::shared_ptr<EventManager::Event> event);

View File

@ -28,6 +28,23 @@
// forward declaration of EventManager::Participant
class Participant;
/**
* @class Manager
*
* If you use the manager it has to be a shared pointer. Otherwise you will
* get a mem error.
*
* To add participants to the manager call class function connect.
* Calling start method will start the manager.
*
* Depending on your concept you can first connect all participants to
* the manager and then start it. Or you can start in first and then
* connect the participants. In the first example all participant will
* be started at the same time (when calling start from the manager.)
* In the second example they will be started when they are connected.
* That means if you have one starting event that all participants need
* to receive you would choose example 1.
*/
class Manager : public std::enable_shared_from_this<Manager>
{
/// the thread the event manager is transmitting events in
@ -66,7 +83,7 @@
/// list of all plugins requiring scheduling
std::list<std::shared_ptr<EventManager::Participant>> schedulingParticipants_;
/// mutex to protect schedulingPlugins_
/// mutex to protect list schedulingParticipants_
std::mutex mutexSchedulingParticipants_;
/// list of all participants connected
@ -152,7 +169,7 @@
/**
* @brief The constructor for the event manager
*
* Just initializes all attributes to its starting value
* Just initializes all attributes to their starting values
*/
Manager() : mainThread_(nullptr), isMainThreadRunning_(false),
stopMainThread_(false), schedulingThread_(nullptr),
@ -161,6 +178,7 @@
~Manager();
/**
* @brief start the event manager
*/

View File

@ -27,6 +27,9 @@
/**
* @brief The entity participating in the event system.
*
* If you want the participant to be scheduled from the manager call
* _enableScheduling class function.
*/
class Participant : public std::enable_shared_from_this<Participant>
{