diff --git a/annotated.html b/annotated.html index 9a77df6..65ad26a 100644 --- a/annotated.html +++ b/annotated.html @@ -89,11 +89,11 @@  CksWifiConfiguratorKsWifiConfigurator component class  CksWifiConnectorA component that manages WiFi connection  Nevt - CksEvent - CksEventHandle - CksEventInterface + CksEventBase class for multicasting events + CksEventHandleImplements event handle, used to automatically unbind callback on destruction + CksEventInterfaceImplements interface for multicasting events  Nmisc - CksWSServer + CksWSServerWrapper around WebSocketsServerCore that adds WebSocket authentication and better message handling  CksApplicationA class that is a base for user-defined application  CksAppRotatorApplication rotator component  CksCertFingerprintInterface for certificate fingerprint verification diff --git a/classksf_1_1comps_1_1ks_config_provider.html b/classksf_1_1comps_1_1ks_config_provider.html index ba2f654..040e508 100644 --- a/classksf_1_1comps_1_1ks_config_provider.html +++ b/classksf_1_1comps_1_1ks_config_provider.html @@ -153,10 +153,10 @@ - + - +

Protected Member Functions

void addNewParam (std::string id, std::string value, int maxLength=50, EConfigParamType::Type type={})
void addNewParam (std::string id, std::string value, int maxLength=50, EConfigParamType::Type type={})
 Defines new configutation parameter.
 
void addNewParamWithConfigDefault (ksConfig &config, std::string id, int maxLength=50, EConfigParamType::Type type={})
void addNewParamWithConfigDefault (ksConfig &config, std::string id, int maxLength=50, EConfigParamType::Type type={})
 Defines new configuation parameter (with default value).
 
@@ -201,7 +201,7 @@

- +
EConfigParamType::Type type = {} )EConfigParamType::Type type = {} )
@@ -253,7 +253,7 @@

- EConfigParamType::Type type = {} ) + EConfigParamType::Type type = {} ) diff --git a/classksf_1_1comps_1_1ks_mqtt_config_provider.html b/classksf_1_1comps_1_1ks_mqtt_config_provider.html index 7822552..b41cc63 100644 --- a/classksf_1_1comps_1_1ks_mqtt_config_provider.html +++ b/classksf_1_1comps_1_1ks_mqtt_config_provider.html @@ -160,10 +160,10 @@

Additional Inherited Members

- Protected Member Functions inherited from ksf::comps::ksConfigProvider -void addNewParam (std::string id, std::string value, int maxLength=50, EConfigParamType::Type type={}) +void addNewParam (std::string id, std::string value, int maxLength=50, EConfigParamType::Type type={})  Defines new configutation parameter.
  -void addNewParamWithConfigDefault (ksConfig &config, std::string id, int maxLength=50, EConfigParamType::Type type={}) +void addNewParamWithConfigDefault (ksConfig &config, std::string id, int maxLength=50, EConfigParamType::Type type={})  Defines new configuation parameter (with default value).
  - Protected Attributes inherited from ksf::comps::ksConfigProvider diff --git a/classksf_1_1evt_1_1ks_event.html b/classksf_1_1evt_1_1ks_event.html index 688a638..f42df22 100644 --- a/classksf_1_1evt_1_1ks_event.html +++ b/classksf_1_1evt_1_1ks_event.html @@ -82,6 +82,11 @@
ksf::evt::ksEvent< Params > Class Template Reference
+ +

Base class for multicasting events. + More...

+ +

#include <ksEvent.h>

+ Inheritance diagram for ksf::evt::ksEvent< Params >:
@@ -90,7 +95,7 @@
-ksf::evt::ksEventInterface +ksf::evt::ksEventInterface
@@ -123,7 +128,16 @@

Additional Inherited Members

-

Member Function Documentation

+

Detailed Description

+
template<typename... Params>
+class ksf::evt::ksEvent< Params >

Base class for multicasting events.

+
Template Parameters
+ + +
Params...Event parameters.
+
+
+

Member Function Documentation

◆ broadcast()

@@ -229,7 +243,7 @@

Parameters
- +
outHandleReference to outHandle shared ptr (destruction of ksEventHandle object will unbind the event)
outHandleReference to outHandle shared ptr (destruction of ksEventHandle object will unbind the event)
functionR-value reference to callback function
@@ -267,7 +281,7 @@

Unbinds event callback by specified unique ID.

-

This ID is automatically assigned by registerEvent function and ksEventHandle uses it to unbind automatically upon destruction.

+

This ID is automatically assigned by registerEvent function and ksEventHandle uses it to unbind automatically upon destruction.

Parameters
diff --git a/classksf_1_1evt_1_1ks_event_handle.html b/classksf_1_1evt_1_1ks_event_handle.html index b5be811..106a63f 100644 --- a/classksf_1_1evt_1_1ks_event_handle.html +++ b/classksf_1_1evt_1_1ks_event_handle.html @@ -82,6 +82,11 @@
ksf::evt::ksEventHandle Class Reference
+ +

Implements event handle, used to automatically unbind callback on destruction. + More...

+ +

#include <ksEventHandle.h>

callbackUIDUnique id of the callback to unbind.
@@ -104,7 +109,10 @@

Public Member Functions

 Unique callback ID.
 
-

Constructor & Destructor Documentation

+

Detailed Description

+

Implements event handle, used to automatically unbind callback on destruction.

+

This is very important to avoid crashing the program in case that user forgets to unbind the callback. Instead, the event handle will unbind the callback automatically when parent object is destroyed.

+

Constructor & Destructor Documentation

◆ ksEventHandle()

diff --git a/classksf_1_1evt_1_1ks_event_interface.html b/classksf_1_1evt_1_1ks_event_interface.html index 59af625..745d9ef 100644 --- a/classksf_1_1evt_1_1ks_event_interface.html +++ b/classksf_1_1evt_1_1ks_event_interface.html @@ -82,6 +82,11 @@
ksf::evt::ksEventInterface Class Referenceabstract

+ +

Implements interface for multicasting events. + More...

+ +

#include <ksEventInterface.h>

+ Inheritance diagram for ksf::evt::ksEventInterface:
@@ -93,7 +98,7 @@ ksf::evt::ksEvent<> ksf::evt::ksEvent< const std::string_view &, bool &, std::string & > ksf::evt::ksEvent< const std::string_view &, const std::string_view & > -ksf::evt::ksEvent< Params > +ksf::evt::ksEvent< Params >
@@ -109,7 +114,9 @@ class 
ksEventHandle
 
-

Member Function Documentation

+

Detailed Description

+

Implements interface for multicasting events.

+

Member Function Documentation

◆ unbind()

diff --git a/classksf_1_1misc_1_1ks_w_s_server.html b/classksf_1_1misc_1_1ks_w_s_server.html index bd05928..6c11328 100644 --- a/classksf_1_1misc_1_1ks_w_s_server.html +++ b/classksf_1_1misc_1_1ks_w_s_server.html @@ -83,6 +83,11 @@
ksf::misc::ksWSServer Class Reference
+ +

Wrapper around WebSocketsServerCore that adds WebSocket authentication and better message handling. + More...

+ +

#include <ksWSServer.h>

+ Inheritance diagram for ksf::misc::ksWSServer:
@@ -140,7 +145,9 @@  Callback function to receive messages.
  -

Constructor & Destructor Documentation

+

Detailed Description

+

Wrapper around WebSocketsServerCore that adds WebSocket authentication and better message handling.

+

Constructor & Destructor Documentation

◆ ksWSServer()

diff --git a/doxygen_crawl.html b/doxygen_crawl.html index 8df638b..64b9ebb 100644 --- a/doxygen_crawl.html +++ b/doxygen_crawl.html @@ -65,8 +65,6 @@ - - @@ -86,13 +84,6 @@ - - - - - - - diff --git a/hierarchy.html b/hierarchy.html index 9dd89ef..cdeee71 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -78,17 +78,17 @@
[detail level 1234]
- + - + - + @@ -102,7 +102,7 @@ - +
 Clogger.Colors
 Cstd::enable_shared_from_this
 Cksf::evt::ksEventInterface
 Cksf::evt::ksEventInterfaceImplements interface for multicasting events
 Cksf::evt::ksEvent<>
 Cksf::evt::ksEvent< const std::string_view &, bool &, std::string & >
 Cksf::evt::ksEvent< const std::string_view &, const std::string_view & >
 Cksf::evt::ksEvent< Params >
 Cksf::evt::ksEvent< Params >Base class for multicasting events
 Cksf::ksApplicationA class that is a base for user-defined application
 Cksf::ksAppRotator< AppTypes >Application rotator component
 Cksf::ksCertFingerprintInterface for certificate fingerprint verification
 Cksf::ksConfigImplements low-level configuration file handling
 Cksf::comps::ksConfigParameterA structure that defines configuration parameter
 Cksf::evt::ksEventHandle
 Cksf::evt::ksEventHandleImplements event handle, used to automatically unbind callback on destruction
 Cksf::ksRttiImplements RTTI (run-time type information) for objects
 Cksf::ksComponentBase component class
 Cksf::comps::ksConfigProviderA component that provides a set of parameters to the ksWifiConfigurator and is also responsible for handling its storage
 Cksf::comps::ksWifiConnectorA component that manages WiFi connection
 Cksf::ksSimpleTimerSimple timer class, without using component architecture
 CWebSocketsServerCore
 Cksf::misc::ksWSServer
 Cksf::misc::ksWSServerWrapper around WebSocketsServerCore that adds WebSocket authentication and better message handling
diff --git a/ks_config_provider_8h_source.html b/ks_config_provider_8h_source.html index d4445b8..9fcb382 100644 --- a/ks_config_provider_8h_source.html +++ b/ks_config_provider_8h_source.html @@ -108,53 +108,49 @@
23
24namespace ksf::comps
25{
-
-
29 namespace EConfigParamType
-
30 {
-
-
34 enum Type
-
35 {
-
36 Text,
-
37 Password,
-
38 Number
-
39 };
+
26 namespace EConfigParamType
+
27 {
+
31 enum Type
+
32 {
+
33 Text,
+
34 Password,
+
35 Number
+
36 };
+
37 };
+
38
+
+ +
43 {
+
44 std::string id;
+
45 std::string defaultValue;
+
46 std::string value;
+
47 EConfigParamType::Type type{};
+
48 int maxLength{};
+
49 };
-
40 };
+
50
+
+ +
64 {
+
65 KSF_RTTI_DECLARATIONS(ksConfigProvider, ksComponent)
+
66
+
67 protected:
+
68 std::list<ksConfigParameter> params;
+
69
+
78 void addNewParam(std::string id, std::string value, int maxLength = 50, EConfigParamType::Type type = {});
+
79
+
89 void addNewParamWithConfigDefault(ksConfig& config, std::string id, int maxLength = 50, EConfigParamType::Type type = {});
+
90
+
91 public:
+
95 std::list<ksConfigParameter>& getParameters();
+
96
+
100 virtual void readParams() = 0;
+
101
+
105 virtual void saveParams() = 0;
+
106 };
-
41
-
- -
46 {
-
47 std::string id;
-
48 std::string defaultValue;
-
49 std::string value;
- -
51 int maxLength{};
-
52 };
-
-
53
-
- -
67 {
-
68 KSF_RTTI_DECLARATIONS(ksConfigProvider, ksComponent)
-
69
-
70 protected:
-
71 std::list<ksConfigParameter> params;
-
72
-
81 void addNewParam(std::string id, std::string value, int maxLength = 50, EConfigParamType::Type type = {});
-
82
-
92 void addNewParamWithConfigDefault(ksConfig& config, std::string id, int maxLength = 50, EConfigParamType::Type type = {});
-
93
-
94 public:
-
98 std::list<ksConfigParameter>& getParameters();
-
99
-
103 virtual void readParams() = 0;
-
104
-
108 virtual void saveParams() = 0;
-
109 };
-
-
110}
-
A component that provides a set of parameters to the ksWifiConfigurator and is also responsible for h...
Definition ksConfigProvider.h:67
+
107}
+
A component that provides a set of parameters to the ksWifiConfigurator and is also responsible for h...
Definition ksConfigProvider.h:64
virtual void readParams()=0
Populates the parameter list by processing the configuration file.
virtual void saveParams()=0
Outputs the parameter list to the configuration file.
std::list< ksConfigParameter > & getParameters()
Provides const reference to the list of managed parameters.
Definition ksConfigProvider.cpp:34
@@ -162,8 +158,7 @@
void addNewParamWithConfigDefault(ksConfig &config, std::string id, int maxLength=50, EConfigParamType::Type type={})
Defines new configuation parameter (with default value).
Definition ksConfigProvider.cpp:28
Base component class.
Definition ksComponent.h:51
Implements low-level configuration file handling.
Definition ksConfig.h:31
-
Type
Configuration parameter type enum.
Definition ksConfigProvider.h:35
-
A structure that defines configuration parameter.
Definition ksConfigProvider.h:46
+
A structure that defines configuration parameter.
Definition ksConfigProvider.h:43