kcenon::monitoring::component_lifecycle_event Class Reference

Event for component lifecycle changes. More...

#include <event_types.h>

Inheritance diagram for kcenon::monitoring::component_lifecycle_event:

Collaboration diagram for kcenon::monitoring::component_lifecycle_event:

Public Types
enum class	lifecycle_state {   initializing , started , running , pausing ,   paused , resuming , stopping , stopped ,   error }

Public Member Functions
	component_lifecycle_event (const std::string &component, lifecycle_state old_state, lifecycle_state new_state, const std::string &reason="")
std::string	get_type_name () const override
	Get the event type name.
const std::string &	get_component () const
lifecycle_state	get_old_state () const
lifecycle_state	get_new_state () const
const std::string &	get_reason () const
Public Member Functions inherited from kcenon::monitoring::event_base
virtual	~event_base ()=default
std::chrono::steady_clock::time_point	get_timestamp () const
	Get timestamp when event was created.
uint64_t	get_id () const
	Get unique event ID.

Private Attributes
std::string	component_
lifecycle_state	old_state_
lifecycle_state	new_state_
std::string	reason_

Additional Inherited Members
Protected Member Functions inherited from kcenon::monitoring::event_base
	event_base ()

Detailed Description

Event for component lifecycle changes.

Examples

event_bus_example.cpp.

Definition at line 249 of file event_types.h.

Member Enumeration Documentation

lifecycle_state

enum class kcenon::monitoring::component_lifecycle_event::lifecycle_state

strong

Enumerator
initializing
started
running
pausing
paused
resuming
stopping
stopped
error

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/core/event_types.h.

Definition at line 251 of file event_types.h.

                               {
        initializing,
        started,
        running,
        pausing,
        paused,
        resuming,
        stopping,
        stopped,
        error
    };

Constructor & Destructor Documentation

component_lifecycle_event()

kcenon::monitoring::component_lifecycle_event::component_lifecycle_event ( const std::string & component, lifecycle_state old_state, lifecycle_state new_state, const std::string & reason = "" )

inline

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/core/event_types.h.

Definition at line 263 of file event_types.h.

        : component_(component), old_state_(old_state),
          new_state_(new_state), reason_(reason) {}

Member Function Documentation

get_component()

const std::string & kcenon::monitoring::component_lifecycle_event::get_component ( ) const

inline

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/core/event_types.h.

Definition at line 274 of file event_types.h.

{ return component_; }

References component_.

get_new_state()

lifecycle_state kcenon::monitoring::component_lifecycle_event::get_new_state ( ) const

inline

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/core/event_types.h.

Definition at line 276 of file event_types.h.

{ return new_state_; }

References new_state_.

get_old_state()

lifecycle_state kcenon::monitoring::component_lifecycle_event::get_old_state ( ) const

inline

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/core/event_types.h.

Definition at line 275 of file event_types.h.

{ return old_state_; }

References old_state_.

get_reason()

const std::string & kcenon::monitoring::component_lifecycle_event::get_reason ( ) const

inline

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/core/event_types.h.

Definition at line 277 of file event_types.h.

{ return reason_; }

References reason_.

get_type_name()

std::string kcenon::monitoring::component_lifecycle_event::get_type_name ( ) const

inlineoverridevirtual

Get the event type name.

Returns

String representation of the event type

Implements kcenon::monitoring::event_base.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/core/event_types.h.

Definition at line 270 of file event_types.h.

                                             {
        return "component_lifecycle_event";
    }

Member Data Documentation

component_

std::string kcenon::monitoring::component_lifecycle_event::component_

private

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/core/event_types.h.

Definition at line 280 of file event_types.h.

Referenced by get_component().

new_state_

lifecycle_state kcenon::monitoring::component_lifecycle_event::new_state_

private

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/core/event_types.h.

Definition at line 282 of file event_types.h.

Referenced by get_new_state().

old_state_

lifecycle_state kcenon::monitoring::component_lifecycle_event::old_state_

private

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/core/event_types.h.

Definition at line 281 of file event_types.h.

Referenced by get_old_state().

reason_

std::string kcenon::monitoring::component_lifecycle_event::reason_

private

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/core/event_types.h.

Definition at line 283 of file event_types.h.

Referenced by get_reason().

---

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

• include/kcenon/monitoring/core/event_types.h