deploy: 8793e10

classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter-members.html

@@ -106,9 +106,10 @@
   <tr class="odd"><td class="entry"><a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a7336a2878a69f0f9452ae39fcfbc1412">loop</a>(ksApplication *app) override</td><td class="entry"><a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html">ksf::comps::ksDevStatMqttReporter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#aaf36a1e5900bef0469f527f962174723">mqttConnWp</a></td><td class="entry"><a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html">ksf::comps::ksDevStatMqttReporter</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a50a8b87a541070e20616a0815ce881d8">onConnected</a>()</td><td class="entry"><a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html">ksf::comps::ksDevStatMqttReporter</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a762ce8b72ef72aa6142a318ad5752c7a">postInit</a>(ksApplication *app) override</td><td class="entry"><a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html">ksf::comps::ksDevStatMqttReporter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
-  <tr class="odd"><td class="entry"><a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a4c5d0897b01f93c21dace3130746bdc5">reportDevStats</a>() const</td><td class="entry"><a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html">ksf::comps::ksDevStatMqttReporter</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a791ce03611c217822caabf91c6c601b1">reporterTimer</a></td><td class="entry"><a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html">ksf::comps::ksDevStatMqttReporter</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#af0e8a72ec0550794dd846ee7e72b5f90">onReportCustomStats</a></td><td class="entry"><a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html">ksf::comps::ksDevStatMqttReporter</a></td><td class="entry"></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a762ce8b72ef72aa6142a318ad5752c7a">postInit</a>(ksApplication *app) override</td><td class="entry"><a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html">ksf::comps::ksDevStatMqttReporter</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a4c5d0897b01f93c21dace3130746bdc5">reportDevStats</a>() const</td><td class="entry"><a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html">ksf::comps::ksDevStatMqttReporter</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a791ce03611c217822caabf91c6c601b1">reporterTimer</a></td><td class="entry"><a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html">ksf::comps::ksDevStatMqttReporter</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
 </table></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>

classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html

@@ -91,6 +91,7 @@
   <div class="summary">
 <a href="#pub-methods">Public Member Functions</a> &#124;
 <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
+<a href="#pub-attribs">Public Attributes</a> &#124;
 <a href="#pro-methods">Protected Member Functions</a> &#124;
 <a href="#pro-attribs">Protected Attributes</a> &#124;
 <a href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter-members.html">List of all members</a>  </div>
@@ -156,6 +157,12 @@
 static const size_t&#160;</td><td class="memItemRight" valign="bottom"><b>getClassType</b> ()</td></tr>
 <tr class="separator:a1259b871ed5c2cd8cc06605be884700c inherit pub_static_methods_classksf_1_1ks_component"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
+Public Attributes</h2></td></tr>
+<tr class="memitem:af0e8a72ec0550794dd846ee7e72b5f90" id="r_af0e8a72ec0550794dd846ee7e72b5f90"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classksf_1_1evt_1_1ks_event.html">ksf::evt::ksEvent</a>&lt; std::shared_ptr&lt; <a class="el" href="classksf_1_1comps_1_1ks_mqtt_connector.html">ksMqttConnector</a> &gt; &amp; &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af0e8a72ec0550794dd846ee7e72b5f90">onReportCustomStats</a> {std::make_shared&lt;<a class="el" href="classksf_1_1evt_1_1ks_event.html">ksf::evt::ksEvent</a>&lt;std::shared_ptr&lt;<a class="el" href="classksf_1_1comps_1_1ks_mqtt_connector.html">ksMqttConnector</a>&gt;&amp;&gt;&gt;()}</td></tr>
+<tr class="memdesc:af0e8a72ec0550794dd846ee7e72b5f90"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when Dev Stat Reporter timer is triggered. Users can bind to this event to add their own stats.  <br /></td></tr>
+<tr class="separator:af0e8a72ec0550794dd846ee7e72b5f90"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</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:a50a8b87a541070e20616a0815ce881d8" id="r_a50a8b87a541070e20616a0815ce881d8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a50a8b87a541070e20616a0815ce881d8">onConnected</a> ()</td></tr>
@@ -388,6 +395,31 @@ <h2 class="memtitle"><span class="permalink"><a href="#a762ce8b72ef72aa6142a318a
 
 <p class="reference">References <a class="el" href="#a9941dae7a03633582619f2bf6973f7e4">connEventHandle</a>, <a class="el" href="classksf_1_1ks_application.html#a944269df1630cce9506ee228c12e1ebb">ksf::ksApplication::findComponent()</a>, <a class="el" href="#aaf36a1e5900bef0469f527f962174723">mqttConnWp</a>, <a class="el" href="#a50a8b87a541070e20616a0815ce881d8">onConnected()</a>, <a class="el" href="classksf_1_1comps_1_1ks_mqtt_connector.html#aeb2e99942201a89db129abe571115db6">ksf::comps::ksMqttConnector::onConnected</a>, and <a class="el" href="classksf_1_1evt_1_1ks_event.html#a172f69d818c73df76abc833fdda016a7">ksf::evt::ksEvent&lt; Params &gt;::registerEvent()</a>.</p>
 
+</div>
+</div>
+<h2 class="groupheader">Member Data Documentation</h2>
+<a id="af0e8a72ec0550794dd846ee7e72b5f90" name="af0e8a72ec0550794dd846ee7e72b5f90"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#af0e8a72ec0550794dd846ee7e72b5f90">&#9670;&#160;</a></span>onReportCustomStats</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">std::shared_ptr&lt;<a class="el" href="classksf_1_1evt_1_1ks_event.html">ksf::evt::ksEvent</a>&lt;std::shared_ptr&lt;<a class="el" href="classksf_1_1comps_1_1ks_mqtt_connector.html">ksMqttConnector</a>&gt;&amp;&gt; &gt; ksf::comps::ksDevStatMqttReporter::onReportCustomStats {std::make_shared&lt;<a class="el" href="classksf_1_1evt_1_1ks_event.html">ksf::evt::ksEvent</a>&lt;std::shared_ptr&lt;<a class="el" href="classksf_1_1comps_1_1ks_mqtt_connector.html">ksMqttConnector</a>&gt;&amp;&gt;&gt;()}</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Called when Dev Stat Reporter timer is triggered. Users can bind to this event to add their own stats. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">param_1</td><td>Shared pointer to the MQTT connector. </td></tr>
+  </table>
+  </dd>
+</dl>
+
+<p class="reference">Referenced by <a class="el" href="#a4c5d0897b01f93c21dace3130746bdc5">reportDevStats()</a>.</p>
+
 </div>
 </div>
 <hr/>The documentation for this class was generated from the following files:<ul>

classksf_1_1evt_1_1ks_event_interface.html

@@ -108,10 +108,11 @@
  <div class="center">
   <img src="classksf_1_1evt_1_1ks_event_interface.png" usemap="#ksf::evt::ksEventInterface_map" alt=""/>
   <map id="ksf::evt::ksEventInterface_map" name="ksf::evt::ksEventInterface_map">
-<area href="classksf_1_1evt_1_1ks_event.html" alt="ksf::evt::ksEvent&lt;&gt;" shape="rect" coords="0,112,404,136"/>
-<area href="classksf_1_1evt_1_1ks_event.html" alt="ksf::evt::ksEvent&lt; const std::string_view &amp;, bool &amp;, std::string &amp; &gt;" shape="rect" coords="414,112,818,136"/>
-<area href="classksf_1_1evt_1_1ks_event.html" alt="ksf::evt::ksEvent&lt; const std::string_view &amp;, const std::string_view &amp; &gt;" shape="rect" coords="828,112,1232,136"/>
-<area href="classksf_1_1evt_1_1ks_event.html" title="Base class for multicasting events." alt="ksf::evt::ksEvent&lt; Params &gt;" shape="rect" coords="1242,112,1646,136"/>
+<area href="classksf_1_1evt_1_1ks_event.html" alt="ksf::evt::ksEvent&lt; std::shared_ptr&lt; ksf::comps::ksMqttConnector &gt; &amp; &gt;" shape="rect" coords="0,112,404,136"/>
+<area href="classksf_1_1evt_1_1ks_event.html" alt="ksf::evt::ksEvent&lt;&gt;" shape="rect" coords="414,112,818,136"/>
+<area href="classksf_1_1evt_1_1ks_event.html" alt="ksf::evt::ksEvent&lt; const std::string_view &amp;, bool &amp;, std::string &amp; &gt;" shape="rect" coords="828,112,1232,136"/>
+<area href="classksf_1_1evt_1_1ks_event.html" alt="ksf::evt::ksEvent&lt; const std::string_view &amp;, const std::string_view &amp; &gt;" shape="rect" coords="1242,112,1646,136"/>
+<area href="classksf_1_1evt_1_1ks_event.html" title="Base class for multicasting events." alt="ksf::evt::ksEvent&lt; Params &gt;" shape="rect" coords="1656,112,2060,136"/>
   </map>
 </div></div>
 <table class="memberdecls">
@@ -161,7 +162,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9da6e0357176b359db6f5004
   </dd>
 </dl>
 
-<p>Implemented in <a class="el" href="classksf_1_1evt_1_1ks_event.html#a28b95e555a1da1bf15b72467f6c133bc">ksf::evt::ksEvent&lt; Params &gt;</a>, <a class="el" href="classksf_1_1evt_1_1ks_event.html#a28b95e555a1da1bf15b72467f6c133bc">ksf::evt::ksEvent&lt; const std::string_view &amp;, bool &amp;, std::string &amp; &gt;</a>, <a class="el" href="classksf_1_1evt_1_1ks_event.html#a28b95e555a1da1bf15b72467f6c133bc">ksf::evt::ksEvent&lt; const std::string_view &amp;, const std::string_view &amp; &gt;</a>, and <a class="el" href="classksf_1_1evt_1_1ks_event.html#a28b95e555a1da1bf15b72467f6c133bc">ksf::evt::ksEvent&lt;&gt;</a>.</p>
+<p>Implemented in <a class="el" href="classksf_1_1evt_1_1ks_event.html#a28b95e555a1da1bf15b72467f6c133bc">ksf::evt::ksEvent&lt; Params &gt;</a>, <a class="el" href="classksf_1_1evt_1_1ks_event.html#a28b95e555a1da1bf15b72467f6c133bc">ksf::evt::ksEvent&lt; const std::string_view &amp;, bool &amp;, std::string &amp; &gt;</a>, <a class="el" href="classksf_1_1evt_1_1ks_event.html#a28b95e555a1da1bf15b72467f6c133bc">ksf::evt::ksEvent&lt; const std::string_view &amp;, const std::string_view &amp; &gt;</a>, <a class="el" href="classksf_1_1evt_1_1ks_event.html#a28b95e555a1da1bf15b72467f6c133bc">ksf::evt::ksEvent&lt; std::shared_ptr&lt; ksf::comps::ksMqttConnector &gt; &amp; &gt;</a>, and <a class="el" href="classksf_1_1evt_1_1ks_event.html#a28b95e555a1da1bf15b72467f6c133bc">ksf::evt::ksEvent&lt;&gt;</a>.</p>
 
 </div>
 </div>

doxygen_crawl.html

@@ -186,6 +186,7 @@
 <a href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#a9941dae7a03633582619f2bf6973f7e4"/>
 <a href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#aaf36a1e5900bef0469f527f962174723"/>
 <a href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#aeba778fa1e37f1b71e24e9e6a3659067"/>
+<a href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#af0e8a72ec0550794dd846ee7e72b5f90"/>
 <a href="classksf_1_1comps_1_1ks_device_portal.html"/>
 <a href="classksf_1_1comps_1_1ks_device_portal.html#a08bf056d0703b80eebf334e2e3830813"/>
 <a href="classksf_1_1comps_1_1ks_device_portal.html#a0ed6c88eac9a0254d732d74566ca12b1"/>

functions_o.html

@@ -93,6 +93,7 @@ <h3><a id="index_o" name="index_o"></a>- o -</h3><ul>
 <li>onDeviceMessage&#160;:&#160;<a class="el" href="classksf_1_1comps_1_1ks_mqtt_connector.html#aff442ccec76a46a0834a21cd882e8ccd">ksf::comps::ksMqttConnector</a></li>
 <li>onDisconnected&#160;:&#160;<a class="el" href="classksf_1_1comps_1_1ks_mqtt_connector.html#aacb8a4b214c5ea6d71c74469fec167ce">ksf::comps::ksMqttConnector</a></li>
 <li>onHandlePortalCommand&#160;:&#160;<a class="el" href="classksf_1_1comps_1_1ks_device_portal.html#a48dce11cf0fbd3747ab5b5a82db32b54">ksf::comps::ksDevicePortal</a></li>
+<li>onReportCustomStats&#160;:&#160;<a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#af0e8a72ec0550794dd846ee7e72b5f90">ksf::comps::ksDevStatMqttReporter</a></li>
 <li>onRequest_index()&#160;:&#160;<a class="el" href="classksf_1_1comps_1_1ks_device_portal.html#a80b467535ec6279ad36ffaa1c181ad90">ksf::comps::ksDevicePortal</a></li>
 <li>onRequest_notFound()&#160;:&#160;<a class="el" href="classksf_1_1comps_1_1ks_device_portal.html#a8feb8377e4cebd8c15e64071a62ae9fa">ksf::comps::ksDevicePortal</a></li>
 <li>onRequest_otaChunk()&#160;:&#160;<a class="el" href="classksf_1_1comps_1_1ks_device_portal.html#a874a08f061b795a96dc4badf7415fd82">ksf::comps::ksDevicePortal</a></li>

functions_vars.html

@@ -164,6 +164,7 @@ <h3><a id="index_o" name="index_o"></a>- o -</h3><ul>
 <li>onDeviceMessage&#160;:&#160;<a class="el" href="classksf_1_1comps_1_1ks_mqtt_connector.html#aff442ccec76a46a0834a21cd882e8ccd">ksf::comps::ksMqttConnector</a></li>
 <li>onDisconnected&#160;:&#160;<a class="el" href="classksf_1_1comps_1_1ks_mqtt_connector.html#aacb8a4b214c5ea6d71c74469fec167ce">ksf::comps::ksMqttConnector</a></li>
 <li>onHandlePortalCommand&#160;:&#160;<a class="el" href="classksf_1_1comps_1_1ks_device_portal.html#a48dce11cf0fbd3747ab5b5a82db32b54">ksf::comps::ksDevicePortal</a></li>
+<li>onReportCustomStats&#160;:&#160;<a class="el" href="classksf_1_1comps_1_1ks_dev_stat_mqtt_reporter.html#af0e8a72ec0550794dd846ee7e72b5f90">ksf::comps::ksDevStatMqttReporter</a></li>
 <li>onUpdateEnd&#160;:&#160;<a class="el" href="classksf_1_1comps_1_1ks_device_portal.html#a7dc2e53045a02c604627f8101baa68e2">ksf::comps::ksDevicePortal</a></li>
 <li>onUpdateStart&#160;:&#160;<a class="el" href="classksf_1_1comps_1_1ks_device_portal.html#a94f2d902c9447d79a165cdb0ed7417ab">ksf::comps::ksDevicePortal</a></li>
 <li>onWebsocketTextMessage&#160;:&#160;<a class="el" href="classksf_1_1misc_1_1ks_w_s_server.html#a507b6d18fbe0c211bec2bb593173d885">ksf::misc::ksWSServer</a></li>