(Commit by workflow script) Update generated documentation.

Flow-IPC · Mar 25, 2024 · f72f6dd · f72f6dd
1 parent c6ae3e5
commit f72f6dd
Show file tree

Hide file tree

Showing 1,008 changed files with 2,059 additions and 2,071 deletions.
diff --git a/doc/flow_doc/generated/html_full/annotated.html b/doc/flow_doc/generated/html_full/annotated.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.0</span>
+   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
    </div>
    <div id="projectbrief">Flow project: Full implementation reference.</div>
   </td>
@@ -200,7 +200,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Wed Mar 20 2024 04:45:34 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
+Generated on Mon Mar 25 2024 07:55:07 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
 </small></address>
 </body>
 </html>
diff --git a/doc/flow_doc/generated/html_full/asio_2node_8cpp.html b/doc/flow_doc/generated/html_full/asio_2node_8cpp.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.0</span>
+   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
    </div>
    <div id="projectbrief">Flow project: Full implementation reference.</div>
   </td>
@@ -93,7 +93,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Wed Mar 20 2024 04:45:33 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
+Generated on Mon Mar 25 2024 07:55:05 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
 </small></address>
 </body>
 </html>
diff --git a/doc/flow_doc/generated/html_full/asio_2node_8cpp_source.html b/doc/flow_doc/generated/html_full/asio_2node_8cpp_source.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.0</span>
+   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
    </div>
    <div id="projectbrief">Flow project: Full implementation reference.</div>
   </td>
@@ -143,7 +143,7 @@
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Wed Mar 20 2024 04:45:33 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
+Generated on Mon Mar 25 2024 07:55:05 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
 </small></address>
 </body>
 </html>
diff --git a/doc/flow_doc/generated/html_full/asio_2node_8hpp.html b/doc/flow_doc/generated/html_full/asio_2node_8hpp.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.0</span>
+   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
    </div>
    <div id="projectbrief">Flow project: Full implementation reference.</div>
   </td>
@@ -102,7 +102,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Wed Mar 20 2024 04:45:33 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
+Generated on Mon Mar 25 2024 07:55:05 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
 </small></address>
 </body>
 </html>
diff --git a/doc/flow_doc/generated/html_full/asio_2node_8hpp_source.html b/doc/flow_doc/generated/html_full/asio_2node_8hpp_source.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.0</span>
+   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
    </div>
    <div id="projectbrief">Flow project: Full implementation reference.</div>
   </td>
@@ -1111,7 +1111,7 @@
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Wed Mar 20 2024 04:45:33 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
+Generated on Mon Mar 25 2024 07:55:05 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
 </small></address>
 </body>
 </html>
diff --git a/doc/flow_doc/generated/html_full/asio_2peer__socket_8cpp.html b/doc/flow_doc/generated/html_full/asio_2peer__socket_8cpp.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.0</span>
+   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
    </div>
    <div id="projectbrief">Flow project: Full implementation reference.</div>
   </td>
@@ -98,7 +98,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Wed Mar 20 2024 04:45:33 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
+Generated on Mon Mar 25 2024 07:55:05 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
 </small></address>
 </body>
 </html>
diff --git a/doc/flow_doc/generated/html_full/asio_2peer__socket_8cpp_source.html b/doc/flow_doc/generated/html_full/asio_2peer__socket_8cpp_source.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.0</span>
+   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
    </div>
    <div id="projectbrief">Flow project: Full implementation reference.</div>
   </td>
@@ -377,7 +377,7 @@
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Wed Mar 20 2024 04:45:33 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
+Generated on Mon Mar 25 2024 07:55:05 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
 </small></address>
 </body>
 </html>
diff --git a/doc/flow_doc/generated/html_full/asio_2peer__socket_8hpp.html b/doc/flow_doc/generated/html_full/asio_2peer__socket_8hpp.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.0</span>
+   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
    </div>
    <div id="projectbrief">Flow project: Full implementation reference.</div>
   </td>
@@ -99,7 +99,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Wed Mar 20 2024 04:45:33 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
+Generated on Mon Mar 25 2024 07:55:05 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
 </small></address>
 </body>
 </html>
diff --git a/doc/flow_doc/generated/html_full/asio_2peer__socket_8hpp_source.html b/doc/flow_doc/generated/html_full/asio_2peer__socket_8hpp_source.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.0</span>
+   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
    </div>
    <div id="projectbrief">Flow project: Full implementation reference.</div>
   </td>
@@ -633,7 +633,7 @@
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Wed Mar 20 2024 04:45:33 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
+Generated on Mon Mar 25 2024 07:55:05 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
 </small></address>
 </body>
 </html>
diff --git a/doc/flow_doc/generated/html_full/asio_2server__socket_8cpp.html b/doc/flow_doc/generated/html_full/asio_2server__socket_8cpp.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.0</span>
+   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
    </div>
    <div id="projectbrief">Flow project: Full implementation reference.</div>
   </td>
@@ -98,7 +98,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Wed Mar 20 2024 04:45:33 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
+Generated on Mon Mar 25 2024 07:55:05 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
 </small></address>
 </body>
 </html>
diff --git a/doc/flow_doc/generated/html_full/asio_2server__socket_8cpp_source.html b/doc/flow_doc/generated/html_full/asio_2server__socket_8cpp_source.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.0</span>
+   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
    </div>
    <div id="projectbrief">Flow project: Full implementation reference.</div>
   </td>
@@ -243,7 +243,7 @@
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Wed Mar 20 2024 04:45:33 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
+Generated on Mon Mar 25 2024 07:55:05 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
 </small></address>
 </body>
 </html>
diff --git a/doc/flow_doc/generated/html_full/asio_2server__socket_8hpp.html b/doc/flow_doc/generated/html_full/asio_2server__socket_8hpp.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.0</span>
+   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
    </div>
    <div id="projectbrief">Flow project: Full implementation reference.</div>
   </td>
@@ -99,7 +99,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Wed Mar 20 2024 04:45:33 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
+Generated on Mon Mar 25 2024 07:55:05 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
 </small></address>
 </body>
 </html>
diff --git a/doc/flow_doc/generated/html_full/asio_2server__socket_8hpp_source.html b/doc/flow_doc/generated/html_full/asio_2server__socket_8hpp_source.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.0</span>
+   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
    </div>
    <div id="projectbrief">Flow project: Full implementation reference.</div>
   </td>
@@ -415,7 +415,7 @@
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Wed Mar 20 2024 04:45:33 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
+Generated on Mon Mar 25 2024 07:55:05 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
 </small></address>
 </body>
 </html>
diff --git a/doc/flow_doc/generated/html_full/async_2util_8hpp.html b/doc/flow_doc/generated/html_full/async_2util_8hpp.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.0</span>
+   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
    </div>
    <div id="projectbrief">Flow project: Full implementation reference.</div>
   </td>
@@ -96,7 +96,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Wed Mar 20 2024 04:45:33 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
+Generated on Mon Mar 25 2024 07:55:05 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
 </small></address>
 </body>
 </html>
diff --git a/doc/flow_doc/generated/html_full/async_2util_8hpp_source.html b/doc/flow_doc/generated/html_full/async_2util_8hpp_source.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.0</span>
+   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
    </div>
    <div id="projectbrief">Flow project: Full implementation reference.</div>
   </td>
@@ -255,12 +255,12 @@
 <div class="ttc" id="anamespaceflow_1_1async_html_a0a06794b16b72f2829ce3353557c8485ae9a9ae292ea3fbbe3b313348dcec0846"><div class="ttname"><a href="namespaceflow_1_1async.html#a0a06794b16b72f2829ce3353557c8485ae9a9ae292ea3fbbe3b313348dcec0846">flow::async::Synchronicity::S_ASYNC_AND_AWAIT_CONCURRENT_START</a></div><div class="ttdeci">@ S_ASYNC_AND_AWAIT_CONCURRENT_START</div><div class="ttdoc">Same as Synchronicity::S_ASYNC but the posting routine then waits as long as necessary for the given ...</div></div>
 <div class="ttc" id="anamespaceflow_1_1async_html_a0a06794b16b72f2829ce3353557c8485aff6bc53ee6c14f2eee463c06d9dff01f"><div class="ttname"><a href="namespaceflow_1_1async.html#a0a06794b16b72f2829ce3353557c8485aff6bc53ee6c14f2eee463c06d9dff01f">flow::async::Synchronicity::S_OPPORTUNISTIC_SYNC_ELSE_ASYNC</a></div><div class="ttdeci">@ S_OPPORTUNISTIC_SYNC_ELSE_ASYNC</div><div class="ttdoc">Execute the given task synchronously, if the scheduler determines that the calling thread is in its t...</div></div>
 <div class="ttc" id="anamespaceflow_1_1async_html_a24567271e97a67d3cae6bd8bf8dc63c4"><div class="ttname"><a href="namespaceflow_1_1async.html#a24567271e97a67d3cae6bd8bf8dc63c4">flow::async::asio_exec_ctx_post</a></div><div class="ttdeci">void asio_exec_ctx_post(log::Logger *logger_ptr, Execution_context *exec_ctx, Synchronicity synchronicity, Task &amp;&amp;task)</div><div class="ttdoc">An extension of boost.asio's post() and dispatch() free function templates, this free function templa...</div><div class="ttdef"><b>Definition:</b> <a href="async_2util_8hpp_source.html#l00031">util.hpp:31</a></div></div>
-<div class="ttc" id="anamespaceflow_1_1async_html_a4cce43f39672e80cba5512103c53ae60"><div class="ttname"><a href="namespaceflow_1_1async.html#a4cce43f39672e80cba5512103c53ae60">flow::async::cpu_idx</a></div><div class="ttdeci">uint16_t cpu_idx()</div><div class="ttdoc">Returns the 0-based processor logical (not hardware) core index of the core executing the calling thr...</div><div class="ttdef"><b>Definition:</b> <a href="async_8cpp_source.html#l00033">async.cpp:33</a></div></div>
+<div class="ttc" id="anamespaceflow_1_1async_html_a4cce43f39672e80cba5512103c53ae60"><div class="ttname"><a href="namespaceflow_1_1async.html#a4cce43f39672e80cba5512103c53ae60">flow::async::cpu_idx</a></div><div class="ttdeci">uint16_t cpu_idx()</div><div class="ttdoc">Returns the 0-based processor logical (not hardware) core index of the core executing the calling thr...</div><div class="ttdef"><b>Definition:</b> <a href="async_8cpp_source.html#l00030">async.cpp:30</a></div></div>
 <div class="ttc" id="anamespaceflow_1_1log_html_a5c602384e6fe9d7642740ac2fae4ad04"><div class="ttname"><a href="namespaceflow_1_1log.html#a5c602384e6fe9d7642740ac2fae4ad04">flow::log::Sev</a></div><div class="ttdeci">Sev</div><div class="ttdoc">Enumeration containing one of several message severity levels, ordered from highest to lowest.</div><div class="ttdef"><b>Definition:</b> <a href="log__fwd_8hpp_source.html#l00223">log_fwd.hpp:224</a></div></div>
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Wed Mar 20 2024 04:45:33 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
+Generated on Mon Mar 25 2024 07:55:05 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
 </small></address>
 </body>
 </html>
diff --git a/doc/flow_doc/generated/html_full/async_8cpp.html b/doc/flow_doc/generated/html_full/async_8cpp.html
@@ -21,7 +21,7 @@
  <tbody>
  <tr id="projectrow">
   <td id="projectalign">
-   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.0</span>
+   <div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
    </div>
    <div id="projectbrief">Flow project: Full implementation reference.</div>
   </td>
@@ -97,7 +97,7 @@
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated on Wed Mar 20 2024 04:45:33 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
+Generated on Mon Mar 25 2024 07:55:05 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
 </small></address>
 </body>
 </html>