kcenon::monitoring::callback_notifier Class Reference

Notifier that invokes a callback function. More...

#include <alert_manager.h>

Inheritance diagram for kcenon::monitoring::callback_notifier:

Collaboration diagram for kcenon::monitoring::callback_notifier:

Public Types
using	callback_func = std::function<void(const alert&)>
using	group_callback_func = std::function<void(const alert_group&)>

Public Member Functions
	callback_notifier (std::string notifier_name, callback_func callback, group_callback_func group_callback=nullptr)
	Construct callback notifier.
std::string	name () const override
	Get the name of this callback notifier.
common::VoidResult	notify (const alert &a) override
	Send a notification for an alert.
common::VoidResult	notify_group (const alert_group &group) override
	Send a notification for an alert group.
bool	is_ready () const override
	Check if the callback notifier is ready.
Public Member Functions inherited from kcenon::monitoring::alert_notifier
virtual	~alert_notifier ()=default

Private Attributes
std::string	name_
callback_func	callback_
group_callback_func	group_callback_

Detailed Description

Notifier that invokes a callback function.

Allows custom notification handling via user-defined callbacks.

Definition at line 491 of file alert_manager.h.

Member Typedef Documentation

callback_func

using kcenon::monitoring::callback_notifier::callback_func = std::function<void(const alert&)>

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_manager.h.

Definition at line 493 of file alert_manager.h.

group_callback_func

using kcenon::monitoring::callback_notifier::group_callback_func = std::function<void(const alert_group&)>

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_manager.h.

Definition at line 494 of file alert_manager.h.

Constructor & Destructor Documentation

callback_notifier()

kcenon::monitoring::callback_notifier::callback_notifier ( std::string notifier_name, callback_func callback, group_callback_func group_callback = nullptr )

inline

Construct callback notifier.

Parameters

notifier_name	Name for this notifier
callback	Callback function for single alerts
group_callback	Callback function for alert groups (optional)

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_manager.h.

Definition at line 502 of file alert_manager.h.

        : name_(std::move(notifier_name))
        , callback_(std::move(callback))
        , group_callback_(std::move(group_callback)) {}

Member Function Documentation

is_ready()

bool kcenon::monitoring::callback_notifier::is_ready ( ) const

inlineoverridevirtual

Check if the callback notifier is ready.

Returns

True if a callback function has been configured

Implements kcenon::monitoring::alert_notifier.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_manager.h.

Definition at line 542 of file alert_manager.h.

{ return callback_ != nullptr; }

References callback_.

name()

std::string kcenon::monitoring::callback_notifier::name ( ) const

inlineoverridevirtual

Get the name of this callback notifier.

Returns

The notifier name string

Implements kcenon::monitoring::alert_notifier.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_manager.h.

Definition at line 513 of file alert_manager.h.

{ return name_; }

References name_.

notify()

common::VoidResult kcenon::monitoring::callback_notifier::notify ( const alert & a )

inlineoverridevirtual

Send a notification for an alert.

Parameters

a	Alert to notify about

Returns

Result indicating success or failure

Implements kcenon::monitoring::alert_notifier.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_manager.h.

Definition at line 515 of file alert_manager.h.

                                                     {
        if (callback_) {
            callback_(a);
            return common::ok();
        }
        return common::VoidResult::err(error_info(monitoring_error_code::operation_failed, "No callback configured").to_common_error());
    }

References callback_, and kcenon::monitoring::operation_failed.

Referenced by notify_group().

Here is the caller graph for this function:

notify_group()

common::VoidResult kcenon::monitoring::callback_notifier::notify_group ( const alert_group & group )

inlineoverridevirtual

Send a notification for an alert group.

Parameters

group

Alert group to notify about

Returns

Result indicating success or failure

Implements kcenon::monitoring::alert_notifier.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_manager.h.

Definition at line 523 of file alert_manager.h.

                                                                     {
        if (group_callback_) {
            group_callback_(group);
            return common::ok();
        }
        // Fall back to individual notifications
        for (const auto& a : group.alerts) {
            auto result = notify(a);
            if (!result.is_ok()) {
                return result;
            }
        }
        return common::ok();
    }

References kcenon::monitoring::alert_group::alerts, group_callback_, and notify().

Here is the call graph for this function:

Member Data Documentation

callback_

callback_func kcenon::monitoring::callback_notifier::callback_

private

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_manager.h.

Definition at line 546 of file alert_manager.h.

Referenced by is_ready(), and notify().

group_callback_

group_callback_func kcenon::monitoring::callback_notifier::group_callback_

private

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_manager.h.

Definition at line 547 of file alert_manager.h.

Referenced by notify_group().

name_

std::string kcenon::monitoring::callback_notifier::name_

private

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_manager.h.

Definition at line 545 of file alert_manager.h.

Referenced by name().

---

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

• include/kcenon/monitoring/alert/alert_manager.h