Doxygen with github
Loading...
Searching...
No Matches
ksDevStatMqttReporter.h
1/*
2 * Copyright (c) 2020-2025, Krzysztof Strehlau
3 *
4 * This file is a part of the ksIotFrameworkLib IoT library.
5 * All licensing information can be found inside LICENSE.md file.
6 *
7 * https://github.com/cziter15/ksIotFrameworkLib/blob/master/LICENSE
8 */
9
10#pragma once
11
12#include "../evt/ksEvent.h"
13#include "../ksComponent.h"
14
15#include "../misc/ksSimpleTimer.h"
16
17namespace ksf::comps
18{
19 class ksMqttConnector;
20
31 {
32 KSF_RTTI_DECLARATIONS(ksDevStatMqttReporter, ksComponent)
33
34 protected:
35 std::weak_ptr<ksMqttConnector> mqttConnWp;
36 std::unique_ptr<evt::ksEventHandle> connEventHandle;
38
46 void onConnected();
47
51 void reportDevStats() const;
52
53 public:
58 DECLARE_KS_EVENT(onReportCustomStats, std::shared_ptr<ksMqttConnector>&)
59
60
64 ksDevStatMqttReporter(uint8_t intervalInSeconds = 60);
65
74 bool postInit(ksApplication* app) override;
75
81 bool loop(ksApplication* app) override;
82 };
83}
A component that periodically reports the device state to the broker.
Definition ksDevStatMqttReporter.h:31
misc::ksSimpleTimer reporterTimer
Timer to report device stats.
Definition ksDevStatMqttReporter.h:37
void reportDevStats() const
Reports device statistics to the MQTT broker.
Definition ksDevStatMqttReporter.cpp:46
void onConnected()
Calback executed on MQTT connection.
Definition ksDevStatMqttReporter.cpp:41
bool loop(ksApplication *app) override
Handles MQTT debug connector component loop logic.
Definition ksDevStatMqttReporter.cpp:60
bool postInit(ksApplication *app) override
Handles component post-initialization.
Definition ksDevStatMqttReporter.cpp:31
std::unique_ptr< evt::ksEventHandle > connEventHandle
Event handle for connection delegate.
Definition ksDevStatMqttReporter.h:36
std::weak_ptr< ksMqttConnector > mqttConnWp
Weak pointer to MQTT connector.
Definition ksDevStatMqttReporter.h:35
ksDevStatMqttReporter(uint8_t intervalInSeconds=60)
Constructs device statistics reporter component.
Definition ksDevStatMqttReporter.cpp:27
std::shared_ptr< ksf::evt::ksEvent< std::shared_ptr< ksMqttConnector > & > > onReportCustomStats
Called when Dev Stat Reporter timer is triggered. Users can bind to this event to add their own stats...
Definition ksDevStatMqttReporter.h:58
A class that serves as the base for user-defined applications.
Definition ksApplication.h:44
Base component class.
Definition ksComponent.h:36
A simple timer class that does not rely on component architecture.
Definition ksSimpleTimer.h:27