Merge pull request #179 from redboltz/refine_client

Fixed comments.

CHANGELOG.adoc

@@ -1,3 +1,5 @@
+:last-update-label!:
+
 = History
 
 == 5.0.0

doc/CHANGELOG.html

@@ -533,7 +533,6 @@ <h2 id="_1_0_0">1.0.0</h2>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-04-29 23:19:43 +0900
 </div>
 </div>
 </body>

doc/api/annotated.html

@@ -165,14 +165,16 @@
 <tr id="row_0_4_11_" 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="classasync__mqtt_1_1v5_1_1disconnect__packet.html" target="_self">disconnect_packet</a></td><td class="desc">MQTT DISCONNECT packet (v5) </td></tr>
 <tr id="row_0_4_12_" 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="classasync__mqtt_1_1v5_1_1pingreq__packet.html" target="_self">pingreq_packet</a></td><td class="desc">MQTT PINGREQ packet (v5) </td></tr>
 <tr id="row_0_4_13_" 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="classasync__mqtt_1_1v5_1_1pingresp__packet.html" target="_self">pingresp_packet</a></td><td class="desc">MQTT PINGRESP packet (v5) </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="classasync__mqtt_1_1basic__endpoint.html" target="_self">basic_endpoint</a></td><td class="desc">MQTT endpoint corresponding to the connection </td></tr>
-<tr id="row_0_6_" 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="classasync__mqtt_1_1basic__packet__variant.html" target="_self">basic_packet_variant</a></td><td class="desc"></td></tr>
-<tr id="row_0_7_" 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="classasync__mqtt_1_1basic__store__packet__variant.html" target="_self">basic_store_packet_variant</a></td><td class="desc">MQTT packet variant for store </td></tr>
-<tr id="row_0_8_" 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="classasync__mqtt_1_1buffer.html" target="_self">buffer</a></td><td class="desc">Buffer that has string_view interface This class provides string_view interface. This class hold string_view target's lifetime optionally </td></tr>
-<tr id="row_0_9_" 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="classasync__mqtt_1_1property__variant.html" target="_self">property_variant</a></td><td class="desc">Property variant </td></tr>
-<tr id="row_0_10_" 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="structasync__mqtt_1_1system__error.html" target="_self">system_error</a></td><td class="desc">Async_mqtt error class. It is used as CompletionToken parameter and exception </td></tr>
-<tr id="row_0_11_" 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="classasync__mqtt_1_1topic__sharename.html" target="_self">topic_sharename</a></td><td class="desc">Topic and sharename </td></tr>
-<tr id="row_0_12_" 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="classasync__mqtt_1_1topic__subopts.html" target="_self">topic_subopts</a></td><td class="desc">Subsscription entry </td></tr>
+<tr id="row_0_5_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_5_" class="arrow" onclick="dynsection.toggleFolder('0_5_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classasync__mqtt_1_1basic__client.html" target="_self">basic_client</a></td><td class="desc">MQTT client for casual usecases </td></tr>
+<tr id="row_0_5_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="structasync__mqtt_1_1basic__client_1_1pubres__t.html" target="_self">pubres_t</a></td><td class="desc">Publish completion handler parameter class </td></tr>
+<tr id="row_0_6_" 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="classasync__mqtt_1_1basic__endpoint.html" target="_self">basic_endpoint</a></td><td class="desc">MQTT endpoint corresponding to the connection </td></tr>
+<tr id="row_0_7_" 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="classasync__mqtt_1_1basic__packet__variant.html" target="_self">basic_packet_variant</a></td><td class="desc"></td></tr>
+<tr id="row_0_8_" 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="classasync__mqtt_1_1basic__store__packet__variant.html" target="_self">basic_store_packet_variant</a></td><td class="desc">MQTT packet variant for store </td></tr>
+<tr id="row_0_9_" 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="classasync__mqtt_1_1buffer.html" target="_self">buffer</a></td><td class="desc">Buffer that has string_view interface This class provides string_view interface. This class hold string_view target's lifetime optionally </td></tr>
+<tr id="row_0_10_" 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="classasync__mqtt_1_1property__variant.html" target="_self">property_variant</a></td><td class="desc">Property variant </td></tr>
+<tr id="row_0_11_" 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="structasync__mqtt_1_1system__error.html" target="_self">system_error</a></td><td class="desc">Async_mqtt error class. It is used as CompletionToken parameter and exception </td></tr>
+<tr id="row_0_12_" 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="classasync__mqtt_1_1topic__sharename.html" target="_self">topic_sharename</a></td><td class="desc">Topic and sharename </td></tr>
+<tr id="row_0_13_" 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="classasync__mqtt_1_1topic__subopts.html" target="_self">topic_subopts</a></td><td class="desc">Subsscription entry </td></tr>
 </table>
 </div><!-- directory -->
 </div><!-- contents -->

doc/api/classasync__mqtt_1_1basic__endpoint.html

@@ -221,10 +221,10 @@
 <tr class="memitem:af0f43d8cdb723fea82a2b0b8a37e5953" id="r_af0f43d8cdb723fea82a2b0b8a37e5953"><td class="memItemLeft" align="right" valign="top">optional&lt; <a class="el" href="#aa7ac549d8d2701f3aaa2fab51a44c7f1">packet_id_t</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af0f43d8cdb723fea82a2b0b8a37e5953">acquire_unique_packet_id</a> ()</td></tr>
 <tr class="memdesc:af0f43d8cdb723fea82a2b0b8a37e5953"><td class="mdescLeft">&#160;</td><td class="mdescRight">acuire unique packet_id.  <br /></td></tr>
 <tr class="separator:af0f43d8cdb723fea82a2b0b8a37e5953"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a69d7bdefdbcfe71c7fa1ce40cbc583b6" id="r_a69d7bdefdbcfe71c7fa1ce40cbc583b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classasync__mqtt_1_1basic__packet__variant.html">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a69d7bdefdbcfe71c7fa1ce40cbc583b6">register_packet_id</a> (<a class="el" href="#aa7ac549d8d2701f3aaa2fab51a44c7f1">packet_id_t</a> <a class="el" href="classasync__mqtt_1_1basic__packet__variant.html">pid</a>)</td></tr>
+<tr class="memitem:a69d7bdefdbcfe71c7fa1ce40cbc583b6" id="r_a69d7bdefdbcfe71c7fa1ce40cbc583b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classasync__mqtt_1_1basic__packet__variant.html">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a69d7bdefdbcfe71c7fa1ce40cbc583b6">register_packet_id</a> (<a class="el" href="#aa7ac549d8d2701f3aaa2fab51a44c7f1">packet_id_t</a> pid)</td></tr>
 <tr class="memdesc:a69d7bdefdbcfe71c7fa1ce40cbc583b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">register packet_id.  <br /></td></tr>
 <tr class="separator:a69d7bdefdbcfe71c7fa1ce40cbc583b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a23bd0f62e5f5e27cb715e37b47b6b754" id="r_a23bd0f62e5f5e27cb715e37b47b6b754"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classasync__mqtt_1_1basic__packet__variant.html">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a23bd0f62e5f5e27cb715e37b47b6b754">release_packet_id</a> (<a class="el" href="#aa7ac549d8d2701f3aaa2fab51a44c7f1">packet_id_t</a> <a class="el" href="classasync__mqtt_1_1basic__packet__variant.html">pid</a>)</td></tr>
+<tr class="memitem:a23bd0f62e5f5e27cb715e37b47b6b754" id="r_a23bd0f62e5f5e27cb715e37b47b6b754"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classasync__mqtt_1_1basic__packet__variant.html">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a23bd0f62e5f5e27cb715e37b47b6b754">release_packet_id</a> (<a class="el" href="#aa7ac549d8d2701f3aaa2fab51a44c7f1">packet_id_t</a> pid)</td></tr>
 <tr class="memdesc:a23bd0f62e5f5e27cb715e37b47b6b754"><td class="mdescLeft">&#160;</td><td class="mdescRight">release packet_id.  <br /></td></tr>
 <tr class="separator:a23bd0f62e5f5e27cb715e37b47b6b754"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a4373b14f01a1954780a55fa108618734" id="r_a4373b14f01a1954780a55fa108618734"><td class="memItemLeft" align="right" valign="top">std::set&lt; <a class="el" href="#aa7ac549d8d2701f3aaa2fab51a44c7f1">packet_id_t</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4373b14f01a1954780a55fa108618734">get_qos2_publish_handled_pids</a> () <a class="el" href="classasync__mqtt_1_1basic__packet__variant.html">const</a></td></tr>
@@ -242,7 +242,7 @@
 <tr class="memitem:a501a5d70d41e7e019bdd606ed0885cef" id="r_a501a5d70d41e7e019bdd606ed0885cef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="protocol__version_8hpp.html#a133d6d106d4e527d07fea2d12544c0c0">protocol_version</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a501a5d70d41e7e019bdd606ed0885cef">get_protocol_version</a> () <a class="el" href="classasync__mqtt_1_1basic__packet__variant.html">const</a></td></tr>
 <tr class="memdesc:a501a5d70d41e7e019bdd606ed0885cef"><td class="mdescLeft">&#160;</td><td class="mdescRight">get MQTT protocol version  <br /></td></tr>
 <tr class="separator:a501a5d70d41e7e019bdd606ed0885cef"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a7c0921ea9afc8294df7ad6516eb7c258" id="r_a7c0921ea9afc8294df7ad6516eb7c258"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classasync__mqtt_1_1basic__packet__variant.html">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7c0921ea9afc8294df7ad6516eb7c258">is_publish_processing</a> (<a class="el" href="#aa7ac549d8d2701f3aaa2fab51a44c7f1">packet_id_t</a> <a class="el" href="classasync__mqtt_1_1basic__packet__variant.html">pid</a>) <a class="el" href="classasync__mqtt_1_1basic__packet__variant.html">const</a></td></tr>
+<tr class="memitem:a7c0921ea9afc8294df7ad6516eb7c258" id="r_a7c0921ea9afc8294df7ad6516eb7c258"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classasync__mqtt_1_1basic__packet__variant.html">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7c0921ea9afc8294df7ad6516eb7c258">is_publish_processing</a> (<a class="el" href="#aa7ac549d8d2701f3aaa2fab51a44c7f1">packet_id_t</a> pid) <a class="el" href="classasync__mqtt_1_1basic__packet__variant.html">const</a></td></tr>
 <tr class="memdesc:a7c0921ea9afc8294df7ad6516eb7c258"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get MQTT PUBLISH packet processing status.  <br /></td></tr>
 <tr class="separator:a7c0921ea9afc8294df7ad6516eb7c258"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ab379a92c9b5839a9cd8f48f1088b21f2" id="r_ab379a92c9b5839a9cd8f48f1088b21f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classasync__mqtt_1_1basic__packet__variant.html">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab379a92c9b5839a9cd8f48f1088b21f2">regulate_for_store</a> (v5::basic_publish_packet&lt; <a class="el" href="classasync__mqtt_1_1basic__packet__variant.html">PacketIdBytes</a> &gt; &amp;packet) <a class="el" href="classasync__mqtt_1_1basic__packet__variant.html">const</a></td></tr>