deploy: c1f3665

annotated.html

@@ -89,11 +89,11 @@
 <tr id="row_0_0_8_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classksf_1_1comps_1_1ks_wifi_configurator.html" target="_self">ksWifiConfigurator</a></td><td class="desc">KsWifiConfigurator component class </td></tr>
 <tr id="row_0_0_9_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classksf_1_1comps_1_1ks_wifi_connector.html" target="_self">ksWifiConnector</a></td><td class="desc">A component that manages WiFi connection </td></tr>
 <tr id="row_0_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_1_" class="arrow" onclick="dynsection.toggleFolder('0_1_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>evt</b></td><td class="desc"></td></tr>
-<tr id="row_0_1_0_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classksf_1_1evt_1_1ks_event.html" target="_self">ksEvent</a></td><td class="desc"></td></tr>
-<tr id="row_0_1_1_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classksf_1_1evt_1_1ks_event_handle.html" target="_self">ksEventHandle</a></td><td class="desc"></td></tr>
-<tr id="row_0_1_2_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classksf_1_1evt_1_1ks_event_interface.html" target="_self">ksEventInterface</a></td><td class="desc"></td></tr>
+<tr id="row_0_1_0_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classksf_1_1evt_1_1ks_event.html" target="_self">ksEvent</a></td><td class="desc">Base class for multicasting events </td></tr>
+<tr id="row_0_1_1_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classksf_1_1evt_1_1ks_event_handle.html" target="_self">ksEventHandle</a></td><td class="desc">Implements event handle, used to automatically unbind callback on destruction </td></tr>
+<tr id="row_0_1_2_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classksf_1_1evt_1_1ks_event_interface.html" target="_self">ksEventInterface</a></td><td class="desc">Implements interface for multicasting events </td></tr>
 <tr id="row_0_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_2_" class="arrow" onclick="dynsection.toggleFolder('0_2_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>misc</b></td><td class="desc"></td></tr>
-<tr id="row_0_2_0_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classksf_1_1misc_1_1ks_w_s_server.html" target="_self">ksWSServer</a></td><td class="desc"></td></tr>
+<tr id="row_0_2_0_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classksf_1_1misc_1_1ks_w_s_server.html" target="_self">ksWSServer</a></td><td class="desc">Wrapper around WebSocketsServerCore that adds WebSocket authentication and better message handling </td></tr>
 <tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classksf_1_1ks_application.html" target="_self">ksApplication</a></td><td class="desc">A class that is a base for user-defined application </td></tr>
 <tr id="row_0_4_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classksf_1_1ks_app_rotator.html" target="_self">ksAppRotator</a></td><td class="desc">Application rotator component </td></tr>
 <tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classksf_1_1ks_cert_fingerprint.html" target="_self">ksCertFingerprint</a></td><td class="desc">Interface for certificate fingerprint verification </td></tr>

classksf_1_1comps_1_1ks_config_provider.html

@@ -153,10 +153,10 @@
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
 Protected Member Functions</h2></td></tr>
-<tr class="memitem:a6e72aedea03159b059f197ebf21a95ef" id="r_a6e72aedea03159b059f197ebf21a95ef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6e72aedea03159b059f197ebf21a95ef">addNewParam</a> (std::string id, std::string value, int maxLength=50, <a class="el" href="namespaceksf_1_1comps_1_1_e_config_param_type.html#a91ac4ffb2e1a9e1f642348a1e89576f1">EConfigParamType::Type</a> type={})</td></tr>
+<tr class="memitem:a6e72aedea03159b059f197ebf21a95ef" id="r_a6e72aedea03159b059f197ebf21a95ef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6e72aedea03159b059f197ebf21a95ef">addNewParam</a> (std::string id, std::string value, int maxLength=50, EConfigParamType::Type type={})</td></tr>
 <tr class="memdesc:a6e72aedea03159b059f197ebf21a95ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines new configutation parameter.  <br /></td></tr>
 <tr class="separator:a6e72aedea03159b059f197ebf21a95ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:af0c39ab3c54f26fd79d55b2c6ec86e92" id="r_af0c39ab3c54f26fd79d55b2c6ec86e92"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af0c39ab3c54f26fd79d55b2c6ec86e92">addNewParamWithConfigDefault</a> (<a class="el" href="classksf_1_1ks_config.html">ksConfig</a> &amp;config, std::string id, int maxLength=50, <a class="el" href="namespaceksf_1_1comps_1_1_e_config_param_type.html#a91ac4ffb2e1a9e1f642348a1e89576f1">EConfigParamType::Type</a> type={})</td></tr>
+<tr class="memitem:af0c39ab3c54f26fd79d55b2c6ec86e92" id="r_af0c39ab3c54f26fd79d55b2c6ec86e92"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af0c39ab3c54f26fd79d55b2c6ec86e92">addNewParamWithConfigDefault</a> (<a class="el" href="classksf_1_1ks_config.html">ksConfig</a> &amp;config, std::string id, int maxLength=50, EConfigParamType::Type type={})</td></tr>
 <tr class="memdesc:af0c39ab3c54f26fd79d55b2c6ec86e92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines new configuation parameter (with default value).  <br /></td></tr>
 <tr class="separator:af0c39ab3c54f26fd79d55b2c6ec86e92"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
@@ -201,7 +201,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6e72aedea03159b059f197eb
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype"><a class="el" href="namespaceksf_1_1comps_1_1_e_config_param_type.html#a91ac4ffb2e1a9e1f642348a1e89576f1">EConfigParamType::Type</a></td>          <td class="paramname"><span class="paramname"><em>type</em><span class="paramdefsep"> = </span><span class="paramdefval">{}</span></span>&#160;)</td>
+          <td class="paramtype">EConfigParamType::Type</td>          <td class="paramname"><span class="paramname"><em>type</em><span class="paramdefsep"> = </span><span class="paramdefval">{}</span></span>&#160;)</td>
         </tr>
       </table>
   </td>
@@ -253,7 +253,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af0c39ab3c54f26fd79d55b2c
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype"><a class="el" href="namespaceksf_1_1comps_1_1_e_config_param_type.html#a91ac4ffb2e1a9e1f642348a1e89576f1">EConfigParamType::Type</a></td>          <td class="paramname"><span class="paramname"><em>type</em><span class="paramdefsep"> = </span><span class="paramdefval">{}</span></span>&#160;)</td>
+          <td class="paramtype">EConfigParamType::Type</td>          <td class="paramname"><span class="paramname"><em>type</em><span class="paramdefsep"> = </span><span class="paramdefval">{}</span></span>&#160;)</td>
         </tr>
       </table>
   </td>

classksf_1_1comps_1_1ks_mqtt_config_provider.html

@@ -160,10 +160,10 @@
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
 Additional Inherited Members</h2></td></tr>
 <tr class="inherit_header pro_methods_classksf_1_1comps_1_1ks_config_provider"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_methods_classksf_1_1comps_1_1ks_config_provider')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classksf_1_1comps_1_1ks_config_provider.html">ksf::comps::ksConfigProvider</a></td></tr>
-<tr class="memitem:a6e72aedea03159b059f197ebf21a95ef inherit pro_methods_classksf_1_1comps_1_1ks_config_provider" id="r_a6e72aedea03159b059f197ebf21a95ef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classksf_1_1comps_1_1ks_config_provider.html#a6e72aedea03159b059f197ebf21a95ef">addNewParam</a> (std::string id, std::string value, int maxLength=50, <a class="el" href="namespaceksf_1_1comps_1_1_e_config_param_type.html#a91ac4ffb2e1a9e1f642348a1e89576f1">EConfigParamType::Type</a> type={})</td></tr>
+<tr class="memitem:a6e72aedea03159b059f197ebf21a95ef inherit pro_methods_classksf_1_1comps_1_1ks_config_provider" id="r_a6e72aedea03159b059f197ebf21a95ef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classksf_1_1comps_1_1ks_config_provider.html#a6e72aedea03159b059f197ebf21a95ef">addNewParam</a> (std::string id, std::string value, int maxLength=50, EConfigParamType::Type type={})</td></tr>
 <tr class="memdesc:a6e72aedea03159b059f197ebf21a95ef inherit pro_methods_classksf_1_1comps_1_1ks_config_provider"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines new configutation parameter.  <br /></td></tr>
 <tr class="separator:a6e72aedea03159b059f197ebf21a95ef inherit pro_methods_classksf_1_1comps_1_1ks_config_provider"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:af0c39ab3c54f26fd79d55b2c6ec86e92 inherit pro_methods_classksf_1_1comps_1_1ks_config_provider" id="r_af0c39ab3c54f26fd79d55b2c6ec86e92"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classksf_1_1comps_1_1ks_config_provider.html#af0c39ab3c54f26fd79d55b2c6ec86e92">addNewParamWithConfigDefault</a> (<a class="el" href="classksf_1_1ks_config.html">ksConfig</a> &amp;config, std::string id, int maxLength=50, <a class="el" href="namespaceksf_1_1comps_1_1_e_config_param_type.html#a91ac4ffb2e1a9e1f642348a1e89576f1">EConfigParamType::Type</a> type={})</td></tr>
+<tr class="memitem:af0c39ab3c54f26fd79d55b2c6ec86e92 inherit pro_methods_classksf_1_1comps_1_1ks_config_provider" id="r_af0c39ab3c54f26fd79d55b2c6ec86e92"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classksf_1_1comps_1_1ks_config_provider.html#af0c39ab3c54f26fd79d55b2c6ec86e92">addNewParamWithConfigDefault</a> (<a class="el" href="classksf_1_1ks_config.html">ksConfig</a> &amp;config, std::string id, int maxLength=50, EConfigParamType::Type type={})</td></tr>
 <tr class="memdesc:af0c39ab3c54f26fd79d55b2c6ec86e92 inherit pro_methods_classksf_1_1comps_1_1ks_config_provider"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines new configuation parameter (with default value).  <br /></td></tr>
 <tr class="separator:af0c39ab3c54f26fd79d55b2c6ec86e92 inherit pro_methods_classksf_1_1comps_1_1ks_config_provider"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="inherit_header pro_attribs_classksf_1_1comps_1_1ks_config_provider"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_attribs_classksf_1_1comps_1_1ks_config_provider')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classksf_1_1comps_1_1ks_config_provider.html">ksf::comps::ksConfigProvider</a></td></tr>

classksf_1_1evt_1_1ks_event.html

@@ -82,6 +82,11 @@
   <div class="headertitle"><div class="title">ksf::evt::ksEvent&lt; Params &gt; Class Template Reference</div></div>
 </div><!--header-->
 <div class="contents">
+
+<p>Base class for multicasting events.  
+ <a href="#details">More...</a></p>
+
+<p><code>#include &lt;<a class="el" href="ks_event_8h_source.html">ksEvent.h</a>&gt;</code></p>
 <div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
   <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for ksf::evt::ksEvent&lt; Params &gt;:</div>
 <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
@@ -90,7 +95,7 @@
  <div class="center">
   <img src="classksf_1_1evt_1_1ks_event.png" usemap="#ksf::evt::ksEvent_3C_20Params_20_3E_map" alt=""/>
   <map id="ksf::evt::ksEvent_3C_20Params_20_3E_map" name="ksf::evt::ksEvent_3C_20Params_20_3E_map">
-<area href="classksf_1_1evt_1_1ks_event_interface.html" alt="ksf::evt::ksEventInterface" shape="rect" coords="0,56,294,80"/>
+<area href="classksf_1_1evt_1_1ks_event_interface.html" title="Implements interface for multicasting events." alt="ksf::evt::ksEventInterface" shape="rect" coords="0,56,294,80"/>
   </map>
 </div></div>
 <table class="memberdecls">
@@ -123,7 +128,16 @@
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
 Additional Inherited Members</h2></td></tr>
 </table>
-<h2 class="groupheader">Member Function Documentation</h2>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><div class="compoundTemplParams">template&lt;typename... Params&gt;<br />
+class ksf::evt::ksEvent&lt; Params &gt;</div><p>Base class for multicasting events. </p>
+<dl class="tparams"><dt>Template Parameters</dt><dd>
+  <table class="tparams">
+    <tr><td class="paramname">Params...</td><td>Event parameters. </td></tr>
+  </table>
+  </dd>
+</dl>
+</div><h2 class="groupheader">Member Function Documentation</h2>
 <a id="ac672facd2bd8e5084f8251b228d2cf4f" name="ac672facd2bd8e5084f8251b228d2cf4f"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#ac672facd2bd8e5084f8251b228d2cf4f">&#9670;&#160;</a></span>broadcast()</h2>
 
@@ -229,7 +243,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a172f69d818c73df76abc833f
 <p>Registers event (binds to callback list). </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">outHandle</td><td>Reference to outHandle shared ptr (destruction of <a class="el" href="classksf_1_1evt_1_1ks_event_handle.html">ksEventHandle</a> object will unbind the event) </td></tr>
+    <tr><td class="paramname">outHandle</td><td>Reference to outHandle shared ptr (destruction of <a class="el" href="classksf_1_1evt_1_1ks_event_handle.html" title="Implements event handle, used to automatically unbind callback on destruction.">ksEventHandle</a> object will unbind the event) </td></tr>
     <tr><td class="paramname">function</td><td>R-value reference to callback function </td></tr>
   </table>
   </dd>
@@ -267,7 +281,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a28b95e555a1da1bf15b72467
 </div><div class="memdoc">
 
 <p>Unbinds event callback by specified unique ID. </p>
-<p>This ID is automatically assigned by registerEvent function and <a class="el" href="classksf_1_1evt_1_1ks_event_handle.html">ksEventHandle</a> uses it to unbind automatically upon destruction.</p>
+<p>This ID is automatically assigned by registerEvent function and <a class="el" href="classksf_1_1evt_1_1ks_event_handle.html" title="Implements event handle, used to automatically unbind callback on destruction.">ksEventHandle</a> uses it to unbind automatically upon destruction.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">callbackUID</td><td>Unique id of the callback to unbind. </td></tr>

classksf_1_1evt_1_1ks_event_handle.html

@@ -82,6 +82,11 @@
   <div class="headertitle"><div class="title">ksf::evt::ksEventHandle Class Reference</div></div>
 </div><!--header-->
 <div class="contents">
+
+<p>Implements event handle, used to automatically unbind callback on destruction.  
+ <a href="#details">More...</a></p>
+
+<p><code>#include &lt;<a class="el" href="ks_event_handle_8h_source.html">ksEventHandle.h</a>&gt;</code></p>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
 Public Member Functions</h2></td></tr>
@@ -104,7 +109,10 @@
 <tr class="memdesc:a275a07831b53b56d77b3b579cb6f7117"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unique callback ID. <br /></td></tr>
 <tr class="separator:a275a07831b53b56d77b3b579cb6f7117"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
-<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>Implements event handle, used to automatically unbind callback on destruction. </p>
+<p>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. </p>
+</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 <a id="a2ba584af638b4d972ecac8ed0660db14" name="a2ba584af638b4d972ecac8ed0660db14"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a2ba584af638b4d972ecac8ed0660db14">&#9670;&#160;</a></span>ksEventHandle()</h2>