Skip to content

Commit c9a9ddb

Browse files
author
github-actions
committed
(Commit by workflow script) Update generated documentation.
1 parent b5637ff commit c9a9ddb

1,008 files changed

Lines changed: 3467 additions & 3456 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

doc/flow_doc/generated/html_full/annotated.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<tbody>
2222
<tr id="projectrow">
2323
<td id="projectalign">
24-
<div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
24+
<div id="projectname">Flow<span id="projectnumber">&#160;1.0.2</span>
2525
</div>
2626
<div id="projectbrief">Flow project: Full implementation reference.</div>
2727
</td>
@@ -200,7 +200,7 @@
200200
</div><!-- contents -->
201201
<!-- start footer part -->
202202
<hr class="footer"/><address class="footer"><small>
203-
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
203+
Generated on Sat Mar 30 2024 01:24:54 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
204204
</small></address>
205205
</body>
206206
</html>

doc/flow_doc/generated/html_full/asio_2node_8cpp.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<tbody>
2222
<tr id="projectrow">
2323
<td id="projectalign">
24-
<div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
24+
<div id="projectname">Flow<span id="projectnumber">&#160;1.0.2</span>
2525
</div>
2626
<div id="projectbrief">Flow project: Full implementation reference.</div>
2727
</td>
@@ -93,7 +93,7 @@
9393
</div><!-- contents -->
9494
<!-- start footer part -->
9595
<hr class="footer"/><address class="footer"><small>
96-
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
96+
Generated on Sat Mar 30 2024 01:24:53 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
9797
</small></address>
9898
</body>
9999
</html>

doc/flow_doc/generated/html_full/asio_2node_8cpp_source.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<tbody>
2222
<tr id="projectrow">
2323
<td id="projectalign">
24-
<div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
24+
<div id="projectname">Flow<span id="projectnumber">&#160;1.0.2</span>
2525
</div>
2626
<div id="projectbrief">Flow project: Full implementation reference.</div>
2727
</td>
@@ -138,12 +138,12 @@
138138
<div class="ttc" id="anamespaceflow_1_1net__flow_1_1asio_html"><div class="ttname"><a href="namespaceflow_1_1net__flow_1_1asio.html">flow::net_flow::asio</a></div><div class="ttdoc">Contains classes that add boost.asio integration to the main Flow-protocol classes such as net_flow::...</div><div class="ttdef"><b>Definition:</b> <a href="asio_2node_8cpp_source.html#l00024">node.cpp:25</a></div></div>
139139
<div class="ttc" id="anamespaceflow_1_1util_html_adf23368210219716b6fd22d15b765cb6"><div class="ttname"><a href="namespaceflow_1_1util.html#adf23368210219716b6fd22d15b765cb6">flow::util::Task_engine</a></div><div class="ttdeci">boost::asio::io_service Task_engine</div><div class="ttdoc">Short-hand for boost.asio event service, the central class of boost.asio.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00135">util_fwd.hpp:135</a></div></div>
140140
<div class="ttc" id="anamespaceflow_1_1util_html_af1b28edb7bad743c1c77f6b982cc3196"><div class="ttname"><a href="namespaceflow_1_1util.html#af1b28edb7bad743c1c77f6b982cc3196">flow::util::Udp_endpoint</a></div><div class="ttdeci">boost::asio::ip::udp::endpoint Udp_endpoint</div><div class="ttdoc">Short-hand for the UDP endpoint (IP/port) type.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00208">util_fwd.hpp:208</a></div></div>
141-
<div class="ttc" id="anamespaceflow_html_a29eaaa9d0fac4ce87d8b969222dbed09"><div class="ttname"><a href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">flow::Error_code</a></div><div class="ttdeci">boost::system::error_code Error_code</div><div class="ttdoc">Short-hand for a boost.system error code (which basically encapsulates an integer/enum error code and...</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00502">common.hpp:502</a></div></div>
141+
<div class="ttc" id="anamespaceflow_html_a29eaaa9d0fac4ce87d8b969222dbed09"><div class="ttname"><a href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">flow::Error_code</a></div><div class="ttdeci">boost::system::error_code Error_code</div><div class="ttdoc">Short-hand for a boost.system error code (which basically encapsulates an integer/enum error code and...</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00503">common.hpp:503</a></div></div>
142142
<div class="ttc" id="astructflow_1_1net__flow_1_1Node__options_html"><div class="ttname"><a href="structflow_1_1net__flow_1_1Node__options.html">flow::net_flow::Node_options</a></div><div class="ttdoc">A set of low-level options affecting a single Flow Node, including Peer_socket objects and other obje...</div><div class="ttdef"><b>Definition:</b> <a href="options_8hpp_source.html#l00448">options.hpp:449</a></div></div>
143143
</div><!-- fragment --></div><!-- contents -->
144144
<!-- start footer part -->
145145
<hr class="footer"/><address class="footer"><small>
146-
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
146+
Generated on Sat Mar 30 2024 01:24:52 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
147147
</small></address>
148148
</body>
149149
</html>

doc/flow_doc/generated/html_full/asio_2node_8hpp.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<tbody>
2222
<tr id="projectrow">
2323
<td id="projectalign">
24-
<div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
24+
<div id="projectname">Flow<span id="projectnumber">&#160;1.0.2</span>
2525
</div>
2626
<div id="projectbrief">Flow project: Full implementation reference.</div>
2727
</td>
@@ -102,7 +102,7 @@
102102
</div><!-- contents -->
103103
<!-- start footer part -->
104104
<hr class="footer"/><address class="footer"><small>
105-
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
105+
Generated on Sat Mar 30 2024 01:24:53 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
106106
</small></address>
107107
</body>
108108
</html>

doc/flow_doc/generated/html_full/asio_2node_8hpp_source.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<tbody>
2222
<tr id="projectrow">
2323
<td id="projectalign">
24-
<div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
24+
<div id="projectname">Flow<span id="projectnumber">&#160;1.0.2</span>
2525
</div>
2626
<div id="projectbrief">Flow project: Full implementation reference.</div>
2727
</td>
@@ -1061,8 +1061,8 @@
10611061
<div class="line"><a id="l00989" name="l00989"></a><span class="lineno"> 989</span>} <span class="comment">// namespace flow::net_flow::asio</span></div>
10621062
<div class="ttc" id="aasio_2peer__socket_8hpp_html"><div class="ttname"><a href="asio_2peer__socket_8hpp.html">peer_socket.hpp</a></div></div>
10631063
<div class="ttc" id="aasio_2server__socket_8hpp_html"><div class="ttname"><a href="asio_2server__socket_8hpp.html">server_socket.hpp</a></div></div>
1064-
<div class="ttc" id="aclassflow_1_1Function_html"><div class="ttname"><a href="classflow_1_1Function.html">flow::Function</a></div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00506">common.hpp:506</a></div></div>
1065-
<div class="ttc" id="aclassflow_1_1log_1_1Log__context_html_af4db395042b065b00398cd59845dcb4d"><div class="ttname"><a href="classflow_1_1log_1_1Log__context.html#af4db395042b065b00398cd59845dcb4d">flow::log::Log_context::get_logger</a></div><div class="ttdeci">Logger * get_logger() const</div><div class="ttdoc">Returns the stored Logger pointer, particularly as many FLOW_LOG_*() macros expect.</div><div class="ttdef"><b>Definition:</b> <a href="log_8cpp_source.html#l00224">log.cpp:224</a></div></div>
1064+
<div class="ttc" id="aclassflow_1_1Function_html"><div class="ttname"><a href="classflow_1_1Function.html">flow::Function</a></div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00507">common.hpp:507</a></div></div>
1065+
<div class="ttc" id="aclassflow_1_1log_1_1Log__context_html_af4db395042b065b00398cd59845dcb4d"><div class="ttname"><a href="classflow_1_1log_1_1Log__context.html#af4db395042b065b00398cd59845dcb4d">flow::log::Log_context::get_logger</a></div><div class="ttdeci">Logger * get_logger() const</div><div class="ttdoc">Returns the stored Logger pointer, particularly as many FLOW_LOG_*() macros expect.</div><div class="ttdef"><b>Definition:</b> <a href="log_8cpp_source.html#l00225">log.cpp:225</a></div></div>
10661066
<div class="ttc" id="aclassflow_1_1log_1_1Logger_html"><div class="ttname"><a href="classflow_1_1log_1_1Logger.html">flow::log::Logger</a></div><div class="ttdoc">Interface that the user should implement, passing the implementing Logger into logging classes (Flow'...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l01287">log.hpp:1291</a></div></div>
10671067
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a19cc3a286c8a11c986d2a59ec1e39a71"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a19cc3a286c8a11c986d2a59ec1e39a71">flow::net_flow::Event_set::Event_type</a></div><div class="ttdeci">Event_type</div><div class="ttdoc">Type of event or condition of interest supported by class Event_set.</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8hpp_source.html#l00306">event_set.hpp:307</a></div></div>
10681068
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html">flow::net_flow::Net_env_simulator</a></div><div class="ttdoc">Objects of this class can be fed to Node to make it internally simulate network conditions like loss,...</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8hpp_source.html#l00067">net_env_simulator.hpp:70</a></div></div>
@@ -1099,9 +1099,9 @@
10991099
<div class="ttc" id="anamespaceflow_1_1util_html_ad92e68a1b22556f2625292098c0036a2"><div class="ttname"><a href="namespaceflow_1_1util.html#ad92e68a1b22556f2625292098c0036a2">flow::util::scheduled_task_cancel</a></div><div class="ttdeci">bool scheduled_task_cancel(log::Logger *logger_ptr, Scheduled_task_handle task)</div><div class="ttdoc">Attempts to prevent the execution of a previously scheduled (by schedule_task_from_now() or similar) ...</div><div class="ttdef"><b>Definition:</b> <a href="sched__task_8cpp_source.html#l00026">sched_task.cpp:26</a></div></div>
11001100
<div class="ttc" id="anamespaceflow_1_1util_html_adf23368210219716b6fd22d15b765cb6"><div class="ttname"><a href="namespaceflow_1_1util.html#adf23368210219716b6fd22d15b765cb6">flow::util::Task_engine</a></div><div class="ttdeci">boost::asio::io_service Task_engine</div><div class="ttdoc">Short-hand for boost.asio event service, the central class of boost.asio.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00135">util_fwd.hpp:135</a></div></div>
11011101
<div class="ttc" id="anamespaceflow_1_1util_html_af1b28edb7bad743c1c77f6b982cc3196"><div class="ttname"><a href="namespaceflow_1_1util.html#af1b28edb7bad743c1c77f6b982cc3196">flow::util::Udp_endpoint</a></div><div class="ttdeci">boost::asio::ip::udp::endpoint Udp_endpoint</div><div class="ttdoc">Short-hand for the UDP endpoint (IP/port) type.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00208">util_fwd.hpp:208</a></div></div>
1102-
<div class="ttc" id="anamespaceflow_html_a29eaaa9d0fac4ce87d8b969222dbed09"><div class="ttname"><a href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">flow::Error_code</a></div><div class="ttdeci">boost::system::error_code Error_code</div><div class="ttdoc">Short-hand for a boost.system error code (which basically encapsulates an integer/enum error code and...</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00502">common.hpp:502</a></div></div>
1103-
<div class="ttc" id="anamespaceflow_html_a48799f1263cdeedec125be51a3db2b79"><div class="ttname"><a href="namespaceflow.html#a48799f1263cdeedec125be51a3db2b79">flow::Fine_duration</a></div><div class="ttdeci">Fine_clock::duration Fine_duration</div><div class="ttdoc">A high-res time duration as computed from two Fine_time_pts.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00410">common.hpp:410</a></div></div>
1104-
<div class="ttc" id="anamespaceflow_html_a9d9cc2eeb10d398cff5591d446b763b8"><div class="ttname"><a href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">flow::Fine_time_pt</a></div><div class="ttdeci">Fine_clock::time_point Fine_time_pt</div><div class="ttdoc">A high-res time point as returned by Fine_clock::now() and suitable for precise time math in general.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00407">common.hpp:407</a></div></div>
1102+
<div class="ttc" id="anamespaceflow_html_a29eaaa9d0fac4ce87d8b969222dbed09"><div class="ttname"><a href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">flow::Error_code</a></div><div class="ttdeci">boost::system::error_code Error_code</div><div class="ttdoc">Short-hand for a boost.system error code (which basically encapsulates an integer/enum error code and...</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00503">common.hpp:503</a></div></div>
1103+
<div class="ttc" id="anamespaceflow_html_a48799f1263cdeedec125be51a3db2b79"><div class="ttname"><a href="namespaceflow.html#a48799f1263cdeedec125be51a3db2b79">flow::Fine_duration</a></div><div class="ttdeci">Fine_clock::duration Fine_duration</div><div class="ttdoc">A high-res time duration as computed from two Fine_time_pts.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00411">common.hpp:411</a></div></div>
1104+
<div class="ttc" id="anamespaceflow_html_a9d9cc2eeb10d398cff5591d446b763b8"><div class="ttname"><a href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">flow::Fine_time_pt</a></div><div class="ttdeci">Fine_clock::time_point Fine_time_pt</div><div class="ttdoc">A high-res time point as returned by Fine_clock::now() and suitable for precise time math in general.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00408">common.hpp:408</a></div></div>
11051105
<div class="ttc" id="anet__flow__fwd_8hpp_html"><div class="ttname"><a href="net__flow__fwd_8hpp.html">net_flow_fwd.hpp</a></div></div>
11061106
<div class="ttc" id="anode_8hpp_html"><div class="ttname"><a href="node_8hpp.html">node.hpp</a></div></div>
11071107
<div class="ttc" id="asched__task_8hpp_html"><div class="ttname"><a href="sched__task_8hpp.html">sched_task.hpp</a></div></div>
@@ -1111,7 +1111,7 @@
11111111
</div><!-- fragment --></div><!-- contents -->
11121112
<!-- start footer part -->
11131113
<hr class="footer"/><address class="footer"><small>
1114-
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
1114+
Generated on Sat Mar 30 2024 01:24:53 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
11151115
</small></address>
11161116
</body>
11171117
</html>

doc/flow_doc/generated/html_full/asio_2peer__socket_8cpp.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<tbody>
2222
<tr id="projectrow">
2323
<td id="projectalign">
24-
<div id="projectname">Flow<span id="projectnumber">&#160;1.0.1</span>
24+
<div id="projectname">Flow<span id="projectnumber">&#160;1.0.2</span>
2525
</div>
2626
<div id="projectbrief">Flow project: Full implementation reference.</div>
2727
</td>
@@ -98,7 +98,7 @@
9898
</div><!-- contents -->
9999
<!-- start footer part -->
100100
<hr class="footer"/><address class="footer"><small>
101-
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
101+
Generated on Sat Mar 30 2024 01:24:53 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
102102
</small></address>
103103
</body>
104104
</html>

0 commit comments

Comments
 (0)