Skip to content

Commit

Permalink
(Commit by workflow script) Update generated documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Feb 8, 2024
1 parent c2a9dad commit 9737210
Show file tree
Hide file tree
Showing 1,166 changed files with 6,102 additions and 7,002 deletions.
2 changes: 1 addition & 1 deletion doc/flow_doc/generated/html_full/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Feb 7 2024 00:49:11 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 Thu Feb 8 2024 11:50:38 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>
2 changes: 1 addition & 1 deletion doc/flow_doc/generated/html_full/asio_2node_8cpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Feb 7 2024 00:49:10 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 Thu Feb 8 2024 11:50:37 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>
4 changes: 2 additions & 2 deletions doc/flow_doc/generated/html_full/asio_2node_8cpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@
<div class="ttc" id="aasio_2node_8hpp_html"><div class="ttname"><a href="asio_2node_8hpp.html">node.hpp</a></div></div>
<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>
<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>
<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#l01299">log.hpp:1303</a></div></div>
<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>
<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>
<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>
<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>
Expand All @@ -143,7 +143,7 @@
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Feb 7 2024 00:49:10 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 Thu Feb 8 2024 11:50:37 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>
2 changes: 1 addition & 1 deletion doc/flow_doc/generated/html_full/asio_2node_8hpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Feb 7 2024 00:49:10 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 Thu Feb 8 2024 11:50:37 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>
4 changes: 2 additions & 2 deletions doc/flow_doc/generated/html_full/asio_2node_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -1063,7 +1063,7 @@
<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>
<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>
<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>
<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#l01299">log.hpp:1303</a></div></div>
<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>
<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>
<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>
<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#l00933">node.hpp:937</a></div></div>
Expand Down Expand Up @@ -1111,7 +1111,7 @@
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Feb 7 2024 00:49:10 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 Thu Feb 8 2024 11:50:37 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>
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Feb 7 2024 00:49:10 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 Thu Feb 8 2024 11:50:37 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>
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno"> 262</span>} <span class="comment">// namespace flow::net_flow::asio</span></div>
<div class="ttc" id="aasio_2node_8hpp_html"><div class="ttname"><a href="asio_2node_8hpp.html">node.hpp</a></div></div>
<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>
<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#l01299">log.hpp:1303</a></div></div>
<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>
<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>
<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>
<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#l03957">peer_socket.cpp:3957</a></div></div>
Expand Down Expand Up @@ -377,7 +377,7 @@
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Feb 7 2024 00:49:10 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 Thu Feb 8 2024 11:50:37 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>
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Feb 7 2024 00:49:10 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 Thu Feb 8 2024 11:50:37 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>
Original file line number Diff line number Diff line change
Expand Up @@ -597,7 +597,7 @@
<div class="line"><a id="l00525" name="l00525"></a><span class="lineno"> 525</span> </div>
<div class="line"><a id="l00526" name="l00526"></a><span class="lineno"> 526</span>} <span class="comment">// namespace flow::net_flow::asio</span></div>
<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>
<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#l01299">log.hpp:1303</a></div></div>
<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>
<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#l00933">node.hpp:937</a></div></div>
<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#l00215">peer_socket.hpp:223</a></div></div>
<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>
Expand Down Expand Up @@ -633,7 +633,7 @@
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Feb 7 2024 00:49:10 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 Thu Feb 8 2024 11:50:37 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>
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Feb 7 2024 00:49:10 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 Thu Feb 8 2024 11:50:37 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>
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span>} <span class="comment">// namespace flow::net_flow::asio</span></div>
<div class="ttc" id="aasio_2node_8hpp_html"><div class="ttname"><a href="asio_2node_8hpp.html">node.hpp</a></div></div>
<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>
<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#l01299">log.hpp:1303</a></div></div>
<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>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a19cc3a286c8a11c986d2a59ec1e39a71afb218b0110d3f9f26ee089bad2e0eba2"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a19cc3a286c8a11c986d2a59ec1e39a71afb218b0110d3f9f26ee089bad2e0eba2">flow::net_flow::Event_set::Event_type::S_SERVER_SOCKET_ACCEPTABLE</a></div><div class="ttdeci">@ S_SERVER_SOCKET_ACCEPTABLE</div><div class="ttdoc">Event type specifying the condition of interest wherein a target Server_socket serv is such that call...</div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html">flow::net_flow::Server_socket</a></div><div class="ttdoc">A server socket able to listen on a single Flow port for incoming connections and return peer sockets...</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8hpp_source.html#l00118">server_socket.hpp:126</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html_a6ba400221e347613c0d101b19602a3a2"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html#a6ba400221e347613c0d101b19602a3a2">flow::net_flow::Server_socket::disconnect_cause</a></div><div class="ttdeci">Error_code disconnect_cause() const</div><div class="ttdoc">The error code that perviously caused state() to become State::S_CLOSED, or success code if state is ...</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8cpp_source.html#l00064">server_socket.cpp:64</a></div></div>
Expand Down Expand Up @@ -243,7 +243,7 @@
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Feb 7 2024 00:49:10 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 Thu Feb 8 2024 11:50:37 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>
Loading

0 comments on commit 9737210

Please sign in to comment.