Skip to content

Commit 0f96595

Browse files
author
github-actions
committed
Sync documentation from Code repo to Pages repo. Possibly update root-page links.
1 parent 1d9b0e7 commit 0f96595

File tree

5,192 files changed

+501004
-0
lines changed

Some content is hidden

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

5,192 files changed

+501004
-0
lines changed

‎README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ Here is the **Flow** online documentation for your immediate perusal (plus relea
4141
- **Flow** branch `main` tip: [documentation](./doc/flow/versions/main/index.html)
4242
- Release **Flow v1.0.0**: [documentation](./doc/flow/versions/v1.0.0/index.html) \| [release info](https://github.com/Flow-IPC/flow/releases/tag/v1.0.0)
4343
- Release **Flow v1.0.1**: [documentation](./doc/flow/versions/v1.0.1/index.html) \| [release info](https://github.com/Flow-IPC/flow/releases/tag/v1.0.1)
44+
- Release **Flow v2.0.0**: [documentation](./doc/flow/versions/v2.0.0/index.html) \| [release info](https://github.com/Flow-IPC/flow/releases/tag/v2.0.0)
4445

4546
[//]: # (massage_root_page.pl:Flow section END.)
4647

‎doc/flow/versions/v2.0.0/generated/html_full/annotated.html

Lines changed: 214 additions & 0 deletions
Large diffs are not rendered by default.

‎doc/flow/versions/v2.0.0/generated/html_full/asio_2node_8cpp.html

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.9.4"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Flow: net_flow/asio/node.cpp File Reference</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr id="projectrow">
23+
<td id="projectalign">
24+
<div id="projectname">Flow<span id="projectnumber">&#160;2.0.0</span>
25+
</div>
26+
<div id="projectbrief">Flow project: Full implementation reference.</div>
27+
</td>
28+
</tr>
29+
</tbody>
30+
</table>
31+
</div>
32+
<!-- end header part -->
33+
<!-- Generated by Doxygen 1.9.4 -->
34+
<script type="text/javascript">
35+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
36+
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
37+
/* @license-end */
38+
</script>
39+
<script type="text/javascript" src="menudata.js"></script>
40+
<script type="text/javascript" src="menu.js"></script>
41+
<script type="text/javascript">
42+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
43+
$(function() {
44+
initMenu('',true,false,'search.php','Search');
45+
$(document).ready(function() { init_search(); });
46+
});
47+
/* @license-end */
48+
</script>
49+
<div id="main-nav"></div>
50+
<!-- window showing the filter options -->
51+
<div id="MSearchSelectWindow"
52+
onmouseover="return searchBox.OnSearchSelectShow()"
53+
onmouseout="return searchBox.OnSearchSelectHide()"
54+
onkeydown="return searchBox.OnSearchSelectKey(event)">
55+
</div>
56+
57+
<!-- iframe showing the search results (closed by default) -->
58+
<div id="MSearchResultsWindow">
59+
<iframe src="javascript:void(0)" frameborder="0"
60+
name="MSearchResults" id="MSearchResults">
61+
</iframe>
62+
</div>
63+
64+
<div id="nav-path" class="navpath">
65+
<ul>
66+
<li class="navelem"><a class="el" href="dir_460afd45d0ec637b1427e0e06a6fbcf7.html">net_flow</a></li><li class="navelem"><a class="el" href="dir_183f5ca7bfa2ee923b1b08301562c36a.html">asio</a></li> </ul>
67+
</div>
68+
</div><!-- top -->
69+
<div class="header">
70+
<div class="summary">
71+
<a href="#namespaces">Namespaces</a> </div>
72+
<div class="headertitle"><div class="title">node.cpp File Reference</div></div>
73+
</div><!--header-->
74+
<div class="contents">
75+
<div class="textblock"><code>#include &quot;<a class="el" href="asio_2node_8hpp_source.html">flow/net_flow/asio/node.hpp</a>&quot;</code><br />
76+
<code>#include &quot;<a class="el" href="asio_2peer__socket_8hpp_source.html">flow/net_flow/asio/peer_socket.hpp</a>&quot;</code><br />
77+
<code>#include &quot;<a class="el" href="asio_2server__socket_8hpp_source.html">flow/net_flow/asio/server_socket.hpp</a>&quot;</code><br />
78+
</div>
79+
<p><a href="asio_2node_8cpp_source.html">Go to the source code of this file.</a></p>
80+
<table class="memberdecls">
81+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
82+
Namespaces</h2></td></tr>
83+
<tr class="memitem:namespaceflow"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceflow.html">flow</a></td></tr>
84+
<tr class="memdesc:namespaceflow"><td class="mdescLeft">&#160;</td><td class="mdescRight">Catch-all namespace for the Flow project: A collection of various production-quality modules written in modern C++17, originally by ygoldfel. <br /></td></tr>
85+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
86+
<tr class="memitem:namespaceflow_1_1net__flow"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceflow_1_1net__flow.html">flow::net_flow</a></td></tr>
87+
<tr class="memdesc:namespaceflow_1_1net__flow"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flow module containing the API and implementation of the <em>Flow network protocol</em>, a TCP-inspired stream protocol that uses UDP as underlying transport. <br /></td></tr>
88+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
89+
<tr class="memitem:namespaceflow_1_1net__flow_1_1asio"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceflow_1_1net__flow_1_1asio.html">flow::net_flow::asio</a></td></tr>
90+
<tr class="memdesc:namespaceflow_1_1net__flow_1_1asio"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains classes that add boost.asio integration to the main Flow-protocol classes such as <a class="el" href="classflow_1_1net__flow_1_1Node.html" title="An object of this class is a single Flow-protocol networking node, in the sense that: (1) it has a di...">net_flow::Node</a> and <a class="el" href="classflow_1_1net__flow_1_1Peer__socket.html" title="A peer (non-server) socket operating over the Flow network protocol, with optional stream-of-bytes an...">net_flow::Peer_socket</a>, so that <code><a class="el" href="namespaceflow_1_1net__flow.html" title="Flow module containing the API and implementation of the Flow network protocol, a TCP-inspired stream...">net_flow</a></code> sockets can be easily used in boost.asio-driven event loops, e.g., ones also performing TCP networking and scheduling timers. <br /></td></tr>
91+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
92+
</table>
93+
</div><!-- contents -->
94+
<!-- start footer part -->
95+
<hr class="footer"/><address class="footer"><small>
96+
Generated on Thu Feb 13 2025 03:56:17 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
97+
</small></address>
98+
</body>
99+
</html>

0 commit comments

Comments
 (0)