Skip to content

Commit d0e69e1

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

File tree

1,333 files changed

+18106
-11133
lines changed

Some content is hidden

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

1,333 files changed

+18106
-11133
lines changed

doc/flow_doc/generated/html_full/annotated.html

Lines changed: 120 additions & 113 deletions
Large diffs are not rendered by default.

doc/flow_doc/generated/html_full/asio_2node_8cpp.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393
</div><!-- contents -->
9494
<!-- start footer part -->
9595
<hr class="footer"/><address class="footer"><small>
96-
Generated on Fri Jan 17 2025 21:56: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
96+
Generated on Wed Feb 5 2025 22:39: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
9797
</small></address>
9898
</body>
9999
</html>

doc/flow_doc/generated/html_full/asio_2node_8cpp_source.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@
127127
<div class="ttc" id="aasio_2node_8hpp_html"><div class="ttname"><a href="asio_2node_8hpp.html">node.hpp</a></div></div>
128128
<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>
129129
<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>
130-
<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>
130+
<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#l01280">log.hpp:1284</a></div></div>
131131
<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>
132132
<div class="ttc" id="aclassflow_1_1net__flow_1_1asio_1_1Node_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1asio_1_1Node.html">flow::net_flow::asio::Node</a></div><div class="ttdoc">A subclass of net_flow::Node that adds the ability to easily and directly use net_flow sockets in gen...</div><div class="ttdef"><b>Definition:</b> <a href="asio_2node_8hpp_source.html#l00234">node.hpp:236</a></div></div>
133133
<div class="ttc" id="aclassflow_1_1net__flow_1_1asio_1_1Node_html_a0e6b29f0ae35a832b0c3c75cf0b577ae"><div class="ttname"><a href="classflow_1_1net__flow_1_1asio_1_1Node.html#a0e6b29f0ae35a832b0c3c75cf0b577ae">flow::net_flow::asio::Node::set_async_task_engine</a></div><div class="ttdeci">void set_async_task_engine(util::Task_engine *target_async_task_engine)</div><div class="ttdoc">Overwrites the value to be returned by next async_task_engine().</div><div class="ttdef"><b>Definition:</b> <a href="asio_2node_8cpp_source.html#l00046">node.cpp:46</a></div></div>
@@ -143,7 +143,7 @@
143143
</div><!-- fragment --></div><!-- contents -->
144144
<!-- start footer part -->
145145
<hr class="footer"/><address class="footer"><small>
146-
Generated on Fri Jan 17 2025 21:56: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
146+
Generated on Wed Feb 5 2025 22:39: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
147147
</small></address>
148148
</body>
149149
</html>

doc/flow_doc/generated/html_full/asio_2node_8hpp.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@
102102
</div><!-- contents -->
103103
<!-- start footer part -->
104104
<hr class="footer"/><address class="footer"><small>
105-
Generated on Fri Jan 17 2025 21:56: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
105+
Generated on Wed Feb 5 2025 22:39: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
106106
</small></address>
107107
</body>
108108
</html>

doc/flow_doc/generated/html_full/asio_2node_8hpp_source.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1062,8 +1062,8 @@
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>
10641064
<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#l00512">common.hpp:512</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>
1066-
<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>
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#l00217">log.cpp:217</a></div></div>
1066+
<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#l01280">log.hpp:1284</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>
10691069
<div class="ttc" id="aclassflow_1_1net__flow_1_1Node_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Node.html">flow::net_flow::Node</a></div><div class="ttdoc">An object of this class is a single Flow-protocol networking node, in the sense that: (1) it has a di...</div><div class="ttdef"><b>Definition:</b> <a href="node_8hpp_source.html#l00930">node.hpp:934</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 Fri Jan 17 2025 21:56: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
1114+
Generated on Wed Feb 5 2025 22:39: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
11151115
</small></address>
11161116
</body>
11171117
</html>

doc/flow_doc/generated/html_full/asio_2peer__socket_8cpp.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
</div><!-- contents -->
9999
<!-- start footer part -->
100100
<hr class="footer"/><address class="footer"><small>
101-
Generated on Fri Jan 17 2025 21:56: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
101+
Generated on Wed Feb 5 2025 22:39: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
102102
</small></address>
103103
</body>
104104
</html>

doc/flow_doc/generated/html_full/asio_2peer__socket_8cpp_source.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@
332332
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno"> 260</span>} <span class="comment">// namespace flow::net_flow::asio</span></div>
333333
<div class="ttc" id="aasio_2node_8hpp_html"><div class="ttname"><a href="asio_2node_8hpp.html">node.hpp</a></div></div>
334334
<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#l00512">common.hpp:512</a></div></div>
335-
<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>
335+
<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#l01280">log.hpp:1284</a></div></div>
336336
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a19cc3a286c8a11c986d2a59ec1e39a71a5efb94617bcb00507a087224ce7a7d02"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a19cc3a286c8a11c986d2a59ec1e39a71a5efb94617bcb00507a087224ce7a7d02">flow::net_flow::Event_set::Event_type::S_PEER_SOCKET_WRITABLE</a></div><div class="ttdeci">@ S_PEER_SOCKET_WRITABLE</div><div class="ttdoc">Event type specifying the condition of interest wherein a target Peer_socket sock is such that callin...</div></div>
337337
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a19cc3a286c8a11c986d2a59ec1e39a71a7cedcbdde2b86daeb1268c63c6cb6b88"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a19cc3a286c8a11c986d2a59ec1e39a71a7cedcbdde2b86daeb1268c63c6cb6b88">flow::net_flow::Event_set::Event_type::S_PEER_SOCKET_READABLE</a></div><div class="ttdeci">@ S_PEER_SOCKET_READABLE</div><div class="ttdoc">Event type specifying the condition of interest wherein a target Peer_socket sock is such that callin...</div></div>
338338
<div class="ttc" id="aclassflow_1_1net__flow_1_1Node_html_ae9a0e5492b9ea005cc12c20c8e7cec9a"><div class="ttname"><a href="classflow_1_1net__flow_1_1Node.html#ae9a0e5492b9ea005cc12c20c8e7cec9a">flow::net_flow::Node::connect_with_metadata</a></div><div class="ttdeci">Peer_socket::Ptr connect_with_metadata(const Remote_endpoint &amp;to, const boost::asio::const_buffer &amp;serialized_metadata, Error_code *err_code=0, const Peer_socket_options *opts=0)</div><div class="ttdoc">Same as connect() but sends, as part of the connection handshake, the user-supplied metadata,...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8cpp_source.html#l03907">peer_socket.cpp:3907</a></div></div>
@@ -375,7 +375,7 @@
375375
</div><!-- fragment --></div><!-- contents -->
376376
<!-- start footer part -->
377377
<hr class="footer"/><address class="footer"><small>
378-
Generated on Fri Jan 17 2025 21:56: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
378+
Generated on Wed Feb 5 2025 22:39: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
379379
</small></address>
380380
</body>
381381
</html>

doc/flow_doc/generated/html_full/asio_2peer__socket_8hpp.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@
9999
</div><!-- contents -->
100100
<!-- start footer part -->
101101
<hr class="footer"/><address class="footer"><small>
102-
Generated on Fri Jan 17 2025 21:56: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
102+
Generated on Wed Feb 5 2025 22:39: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
103103
</small></address>
104104
</body>
105105
</html>

doc/flow_doc/generated/html_full/asio_2peer__socket_8hpp_source.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -596,7 +596,7 @@
596596
<div class="line"><a id="l00524" name="l00524"></a><span class="lineno"> 524</span> </div>
597597
<div class="line"><a id="l00525" name="l00525"></a><span class="lineno"> 525</span>} <span class="comment">// namespace flow::net_flow::asio</span></div>
598598
<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#l00512">common.hpp:512</a></div></div>
599-
<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>
599+
<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#l01280">log.hpp:1284</a></div></div>
600600
<div class="ttc" id="aclassflow_1_1net__flow_1_1Node_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Node.html">flow::net_flow::Node</a></div><div class="ttdoc">An object of this class is a single Flow-protocol networking node, in the sense that: (1) it has a di...</div><div class="ttdef"><b>Definition:</b> <a href="node_8hpp_source.html#l00930">node.hpp:934</a></div></div>
601601
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html">flow::net_flow::Peer_socket</a></div><div class="ttdoc">A peer (non-server) socket operating over the Flow network protocol, with optional stream-of-bytes an...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00216">peer_socket.hpp:224</a></div></div>
602602
<div class="ttc" id="aclassflow_1_1net__flow_1_1asio_1_1Node_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1asio_1_1Node.html">flow::net_flow::asio::Node</a></div><div class="ttdoc">A subclass of net_flow::Node that adds the ability to easily and directly use net_flow sockets in gen...</div><div class="ttdef"><b>Definition:</b> <a href="asio_2node_8hpp_source.html#l00234">node.hpp:236</a></div></div>
@@ -632,7 +632,7 @@
632632
</div><!-- fragment --></div><!-- contents -->
633633
<!-- start footer part -->
634634
<hr class="footer"/><address class="footer"><small>
635-
Generated on Fri Jan 17 2025 21:56: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
635+
Generated on Wed Feb 5 2025 22:39: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
636636
</small></address>
637637
</body>
638638
</html>

doc/flow_doc/generated/html_full/asio_2server__socket_8cpp.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
</div><!-- contents -->
9999
<!-- start footer part -->
100100
<hr class="footer"/><address class="footer"><small>
101-
Generated on Fri Jan 17 2025 21:56: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
101+
Generated on Wed Feb 5 2025 22:39: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
102102
</small></address>
103103
</body>
104104
</html>

0 commit comments

Comments
 (0)