ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 11:05:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/classripple_1_1test_1_1csf_1_1BasicNetwork.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

618 lines
40 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::test::csf::BasicNetwork&lt; Peer &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="namespaceripple_1_1test.html">test</a></li><li class="navelem"><a class="el" href="namespaceripple_1_1test_1_1csf.html">csf</a></li><li class="navelem"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html">BasicNetwork</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-types">Private Types</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1test_1_1csf_1_1BasicNetwork-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::test::csf::BasicNetwork&lt; Peer &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html" title="A single peer in the simulation.">Peer</a> to peer network simulator.
<a href="classripple_1_1test_1_1csf_1_1BasicNetwork.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="BasicNetwork_8h_source.html">BasicNetwork.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::test::csf::BasicNetwork&lt; Peer &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1test_1_1csf_1_1BasicNetwork__coll__graph.png" border="0" usemap="#aripple_1_1test_1_1csf_1_1BasicNetwork_3_01Peer_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1test_1_1csf_1_1BasicNetwork_3_01Peer_01_4_coll__map" id="aripple_1_1test_1_1csf_1_1BasicNetwork_3_01Peer_01_4_coll__map">
<area shape="rect" title="Peer to peer network simulator." alt="" coords="831,91,1001,131"/>
<area shape="rect" href="classripple_1_1test_1_1csf_1_1Scheduler.html" title="Simulated discrete&#45;event scheduler." alt="" coords="537,35,663,75"/>
<area shape="poly" title=" " alt="" coords="677,66,831,93,830,98,676,71"/>
<area shape="rect" href="classripple_1_1test_1_1csf_1_1Scheduler_1_1queue__type.html" title=" " alt="" coords="215,5,385,45"/>
<area shape="poly" title=" " alt="" coords="399,32,537,46,536,51,399,38"/>
<area shape="rect" href="classbeast_1_1manual__clock.html" title=" " alt="" coords="219,70,381,125"/>
<area shape="poly" title=" " alt="" coords="394,81,536,61,537,66,395,87"/>
<area shape="rect" href="classbeast_1_1abstract__clock.html" title="Abstract interface to a clock." alt="" coords="5,77,165,117"/>
<area shape="poly" title=" " alt="" coords="179,95,219,95,219,100,179,100"/>
<area shape="rect" href="classripple_1_1test_1_1csf_1_1Digraph.html" title=" " alt="" coords="485,99,715,168"/>
<area shape="poly" title=" " alt="" coords="728,121,830,114,831,119,729,127"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1test_1_1csf_1_1BasicNetwork_1_1link__type.html">link_type</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab0698c1f1eb647ade9a9ed1e06b193b8" id="r_ab0698c1f1eb647ade9a9ed1e06b193b8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html#ab0698c1f1eb647ade9a9ed1e06b193b8">BasicNetwork</a> (<a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html">BasicNetwork</a> const &amp;)=delete</td></tr>
<tr class="separator:ab0698c1f1eb647ade9a9ed1e06b193b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54c63fa4fb3f8827165f8b1739b60076" id="r_a54c63fa4fb3f8827165f8b1739b60076"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html">BasicNetwork</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html#a54c63fa4fb3f8827165f8b1739b60076">operator=</a> (<a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html">BasicNetwork</a> const &amp;)=delete</td></tr>
<tr class="separator:a54c63fa4fb3f8827165f8b1739b60076"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1901ce31f5b61b9fd676dcc391e5b2e9" id="r_a1901ce31f5b61b9fd676dcc391e5b2e9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html#a1901ce31f5b61b9fd676dcc391e5b2e9">BasicNetwork</a> (<a class="el" href="classripple_1_1test_1_1csf_1_1Scheduler.html">Scheduler</a> &amp;s)</td></tr>
<tr class="separator:a1901ce31f5b61b9fd676dcc391e5b2e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aecb52f02de987d212137a765c37120f9" id="r_aecb52f02de987d212137a765c37120f9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html#aecb52f02de987d212137a765c37120f9">connect</a> (<a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> const &amp;from, <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> const &amp;to, <a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html#a00b57d19a5cf0b314a29faa7840a6587">duration</a> const &amp;delay=<a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a>{0})</td></tr>
<tr class="memdesc:aecb52f02de987d212137a765c37120f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connect two peers. <br /></td></tr>
<tr class="separator:aecb52f02de987d212137a765c37120f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68dbb0ac7acafe15b752f7b097550a50" id="r_a68dbb0ac7acafe15b752f7b097550a50"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html#a68dbb0ac7acafe15b752f7b097550a50">disconnect</a> (<a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> const &amp;peer1, <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> const &amp;peer2)</td></tr>
<tr class="memdesc:a68dbb0ac7acafe15b752f7b097550a50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Break a link. <br /></td></tr>
<tr class="separator:a68dbb0ac7acafe15b752f7b097550a50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b99362b97ce3aa9bbec9a43ca0d4a44" id="r_a2b99362b97ce3aa9bbec9a43ca0d4a44"><td class="memTemplParams" colspan="2">template&lt;class Function &gt; </td></tr>
<tr class="memitem:a2b99362b97ce3aa9bbec9a43ca0d4a44"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html#a2b99362b97ce3aa9bbec9a43ca0d4a44">send</a> (<a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> const &amp;from, <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> const &amp;to, Function &amp;&amp;f)</td></tr>
<tr class="memdesc:a2b99362b97ce3aa9bbec9a43ca0d4a44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a message to a peer. <br /></td></tr>
<tr class="separator:a2b99362b97ce3aa9bbec9a43ca0d4a44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72afc49cdcacd120855180f9febf3c0a" id="r_a72afc49cdcacd120855180f9febf3c0a"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html#a72afc49cdcacd120855180f9febf3c0a">links</a> (<a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> const &amp;from)</td></tr>
<tr class="memdesc:a72afc49cdcacd120855180f9febf3c0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the range of active links. <br /></td></tr>
<tr class="separator:a72afc49cdcacd120855180f9febf3c0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab934937b6ad7b33ba73263045be4371c" id="r_ab934937b6ad7b33ba73263045be4371c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1test_1_1csf_1_1Digraph.html">Digraph</a>&lt; <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a>, <a class="el" href="structripple_1_1test_1_1csf_1_1BasicNetwork_1_1link__type.html">link_type</a> &gt; const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html#ab934937b6ad7b33ba73263045be4371c">graph</a> () const</td></tr>
<tr class="memdesc:ab934937b6ad7b33ba73263045be4371c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the underlying digraph. <br /></td></tr>
<tr class="separator:ab934937b6ad7b33ba73263045be4371c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-types" name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:a2e0f9298ef9768e7d2af6f05e50a568a" id="r_a2e0f9298ef9768e7d2af6f05e50a568a"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html#a2e0f9298ef9768e7d2af6f05e50a568a">peer_type</a> = <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a></td></tr>
<tr class="separator:a2e0f9298ef9768e7d2af6f05e50a568a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88648e3567e60340b7f3da251571e262" id="r_a88648e3567e60340b7f3da251571e262"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html#a88648e3567e60340b7f3da251571e262">clock_type</a> = <a class="el" href="classripple_1_1test_1_1csf_1_1Scheduler.html#a6bec798d034260a5001335e19c3f512f">Scheduler::clock_type</a></td></tr>
<tr class="separator:a88648e3567e60340b7f3da251571e262"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00b57d19a5cf0b314a29faa7840a6587" id="r_a00b57d19a5cf0b314a29faa7840a6587"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html#a00b57d19a5cf0b314a29faa7840a6587">duration</a> = typename <a class="el" href="classbeast_1_1abstract__clock.html#ad024b15fa67696e8d1eba3744e800d32">clock_type::duration</a></td></tr>
<tr class="separator:a00b57d19a5cf0b314a29faa7840a6587"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8c325be02360401c9023c120cb048ba" id="r_ad8c325be02360401c9023c120cb048ba"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html#ad8c325be02360401c9023c120cb048ba">time_point</a> = typename <a class="el" href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">clock_type::time_point</a></td></tr>
<tr class="separator:ad8c325be02360401c9023c120cb048ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a29a40079d51137ca15098e41df0f57ed" id="r_a29a40079d51137ca15098e41df0f57ed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1test_1_1csf_1_1Scheduler.html">Scheduler</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html#a29a40079d51137ca15098e41df0f57ed">scheduler</a></td></tr>
<tr class="separator:a29a40079d51137ca15098e41df0f57ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97f7116d8ee44a3c122c272d77507f02" id="r_a97f7116d8ee44a3c122c272d77507f02"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1test_1_1csf_1_1Digraph.html">Digraph</a>&lt; <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a>, <a class="el" href="structripple_1_1test_1_1csf_1_1BasicNetwork_1_1link__type.html">link_type</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html#a97f7116d8ee44a3c122c272d77507f02">links_</a></td></tr>
<tr class="separator:a97f7116d8ee44a3c122c272d77507f02"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;class <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a>&gt;<br />
class ripple::test::csf::BasicNetwork&lt; Peer &gt;</div><p><a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html" title="A single peer in the simulation.">Peer</a> to peer network simulator. </p>
<p>The network is formed from a set of <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html" title="A single peer in the simulation.">Peer</a> objects representing vertices and configurable connections representing edges. The caller is responsible for creating the <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html" title="A single peer in the simulation.">Peer</a> objects ahead of time.</p>
<p><a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html" title="A single peer in the simulation.">Peer</a> objects cannot be destroyed once the <a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html" title="Peer to peer network simulator.">BasicNetwork</a> is constructed. To handle peers going online and offline, callers can simply disconnect all links and reconnect them later. Connections are directed, one end is the inbound <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html" title="A single peer in the simulation.">Peer</a> and the other is the outbound <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html" title="A single peer in the simulation.">Peer</a>.</p>
<p>Peers may send messages along their connections. To simulate the effects of latency, these messages can be delayed by a configurable duration set when the link is established. Messages always arrive in the order they were sent on a particular connection.</p>
<p>A message is modeled using a lambda function. The caller provides the code to execute upon delivery of the message. If a <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html" title="A single peer in the simulation.">Peer</a> is disconnected, all messages pending delivery at either end of the connection will not be delivered.</p>
<p>When creating the <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html" title="A single peer in the simulation.">Peer</a> set, the caller needs to provide a <a class="el" href="classripple_1_1test_1_1csf_1_1Scheduler.html" title="Simulated discrete-event scheduler.">Scheduler</a> object for managing the timing and delivery of messages. After constructing the network, and establishing connections, the caller uses the scheduler's step_* functions to drive messages through the network.</p>
<p>The graph of peers and connections is internally represented using Digraph&lt;Peer,BasicNetwork::link_type&gt;. Clients have const access to that graph to perform additional operations not directly provided by <a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html" title="Peer to peer network simulator.">BasicNetwork</a>.</p>
<p><a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html" title="A single peer in the simulation.">Peer</a> Requirements: </p><pre class="fragment">Peer should be a lightweight type, cheap to copy
and/or move. A good candidate is a simple pointer to
the underlying user defined type in the simulation.
Expression Type Requirements
---------- ---- ------------
P Peer
u, v Values of type P
P u(v) CopyConstructible
u.~P() Destructible
u == v bool EqualityComparable
u &lt; v bool LessThanComparable
std::hash&lt;P&gt; class std::hash is defined for P
! u bool true if u is not-a-peer
</pre>
<p class="definition">Definition at line <a class="el" href="BasicNetwork_8h_source.html#l00064">64</a> of file <a class="el" href="BasicNetwork_8h_source.html">BasicNetwork.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a2e0f9298ef9768e7d2af6f05e50a568a" name="a2e0f9298ef9768e7d2af6f05e50a568a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e0f9298ef9768e7d2af6f05e50a568a">&#9670;&#160;</a></span>peer_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html">ripple::test::csf::BasicNetwork</a>&lt; <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt;::peer_type = <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BasicNetwork_8h_source.html#l00066">66</a> of file <a class="el" href="BasicNetwork_8h_source.html">BasicNetwork.h</a>.</p>
</div>
</div>
<a id="a88648e3567e60340b7f3da251571e262" name="a88648e3567e60340b7f3da251571e262"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88648e3567e60340b7f3da251571e262">&#9670;&#160;</a></span>clock_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html">ripple::test::csf::BasicNetwork</a>&lt; <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt;::clock_type = <a class="el" href="classripple_1_1test_1_1csf_1_1Scheduler.html#a6bec798d034260a5001335e19c3f512f">Scheduler::clock_type</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BasicNetwork_8h_source.html#l00068">68</a> of file <a class="el" href="BasicNetwork_8h_source.html">BasicNetwork.h</a>.</p>
</div>
</div>
<a id="a00b57d19a5cf0b314a29faa7840a6587" name="a00b57d19a5cf0b314a29faa7840a6587"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00b57d19a5cf0b314a29faa7840a6587">&#9670;&#160;</a></span>duration</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html">ripple::test::csf::BasicNetwork</a>&lt; <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt;::duration = typename <a class="el" href="classbeast_1_1abstract__clock.html#ad024b15fa67696e8d1eba3744e800d32">clock_type::duration</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BasicNetwork_8h_source.html#l00070">70</a> of file <a class="el" href="BasicNetwork_8h_source.html">BasicNetwork.h</a>.</p>
</div>
</div>
<a id="ad8c325be02360401c9023c120cb048ba" name="ad8c325be02360401c9023c120cb048ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8c325be02360401c9023c120cb048ba">&#9670;&#160;</a></span>time_point</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html">ripple::test::csf::BasicNetwork</a>&lt; <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt;::time_point = typename <a class="el" href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">clock_type::time_point</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BasicNetwork_8h_source.html#l00072">72</a> of file <a class="el" href="BasicNetwork_8h_source.html">BasicNetwork.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ab0698c1f1eb647ade9a9ed1e06b193b8" name="ab0698c1f1eb647ade9a9ed1e06b193b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0698c1f1eb647ade9a9ed1e06b193b8">&#9670;&#160;</a></span>BasicNetwork() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html">ripple::test::csf::BasicNetwork</a>&lt; <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt;::BasicNetwork </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html">BasicNetwork</a>&lt; <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt; const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a1901ce31f5b61b9fd676dcc391e5b2e9" name="a1901ce31f5b61b9fd676dcc391e5b2e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1901ce31f5b61b9fd676dcc391e5b2e9">&#9670;&#160;</a></span>BasicNetwork() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html">ripple::test::csf::BasicNetwork</a>&lt; <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt;::BasicNetwork </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1test_1_1csf_1_1Scheduler.html">Scheduler</a> &amp;&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BasicNetwork_8h_source.html#l00181">181</a> of file <a class="el" href="BasicNetwork_8h_source.html">BasicNetwork.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a54c63fa4fb3f8827165f8b1739b60076" name="a54c63fa4fb3f8827165f8b1739b60076"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54c63fa4fb3f8827165f8b1739b60076">&#9670;&#160;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html">BasicNetwork</a> &amp; <a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html">ripple::test::csf::BasicNetwork</a>&lt; <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt;::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html">BasicNetwork</a>&lt; <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt; const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aecb52f02de987d212137a765c37120f9" name="aecb52f02de987d212137a765c37120f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aecb52f02de987d212137a765c37120f9">&#9670;&#160;</a></span>connect()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt; </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html">ripple::test::csf::BasicNetwork</a>&lt; <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt;::connect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> const &amp;&#160;</td>
<td class="paramname"><em>from</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> const &amp;&#160;</td>
<td class="paramname"><em>to</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html#a00b57d19a5cf0b314a29faa7840a6587">duration</a> const &amp;&#160;</td>
<td class="paramname"><em>delay</em> = <code><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a>{0}</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Connect two peers. </p>
<p>The link is directed, with <code>from</code> establishing the outbound connection and <code>to</code> receiving the incoming connection.</p>
<p>Preconditions: </p><pre class="fragment">from != to (self connect disallowed).
A link between from and to does not
already exist (duplicates disallowed).
</pre><p> Effects: </p><pre class="fragment">Creates a link between from and to.
</pre> <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">`from`</td><td>The source of the outgoing connection </td></tr>
<tr><td class="paramname">`to`</td><td>The recipient of the incoming connection </td></tr>
<tr><td class="paramname">`delay`</td><td>The time delay of all delivered messages </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if a new connection was established </dd></dl>
<p class="definition">Definition at line <a class="el" href="BasicNetwork_8h_source.html#l00187">187</a> of file <a class="el" href="BasicNetwork_8h_source.html">BasicNetwork.h</a>.</p>
</div>
</div>
<a id="a68dbb0ac7acafe15b752f7b097550a50" name="a68dbb0ac7acafe15b752f7b097550a50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68dbb0ac7acafe15b752f7b097550a50">&#9670;&#160;</a></span>disconnect()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt; </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html">ripple::test::csf::BasicNetwork</a>&lt; <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt;::disconnect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> const &amp;&#160;</td>
<td class="paramname"><em>peer1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> const &amp;&#160;</td>
<td class="paramname"><em>peer2</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Break a link. </p>
<p>Effects: </p><pre class="fragment">If a connection is present, both ends are
disconnected.
Any pending messages on the connection
are discarded.
</pre> <dl class="section return"><dt>Returns</dt><dd><code>true</code> if a connection was broken. </dd></dl>
<p class="definition">Definition at line <a class="el" href="BasicNetwork_8h_source.html#l00205">205</a> of file <a class="el" href="BasicNetwork_8h_source.html">BasicNetwork.h</a>.</p>
</div>
</div>
<a id="a2b99362b97ce3aa9bbec9a43ca0d4a44" name="a2b99362b97ce3aa9bbec9a43ca0d4a44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b99362b97ce3aa9bbec9a43ca0d4a44">&#9670;&#160;</a></span>send()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt; </div>
<div class="memtemplate">
template&lt;class Function &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html">ripple::test::csf::BasicNetwork</a>&lt; <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt;::send </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> const &amp;&#160;</td>
<td class="paramname"><em>from</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> const &amp;&#160;</td>
<td class="paramname"><em>to</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Function &amp;&amp;&#160;</td>
<td class="paramname"><em>f</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send a message to a peer. </p>
<p>Preconditions: </p><pre class="fragment">A link exists between from and to.
</pre><p> Effects: </p><pre class="fragment">If the link is not broken when the
link's `delay` time has elapsed,
the function will be invoked with
no arguments.
</pre> <dl class="section note"><dt>Note</dt><dd>Its the caller's responsibility to ensure that the body of the function performs activity consistent with <code>from</code>'s receipt of a message from <code>to</code>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="BasicNetwork_8h_source.html#l00218">218</a> of file <a class="el" href="BasicNetwork_8h_source.html">BasicNetwork.h</a>.</p>
</div>
</div>
<a id="a72afc49cdcacd120855180f9febf3c0a" name="a72afc49cdcacd120855180f9febf3c0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72afc49cdcacd120855180f9febf3c0a">&#9670;&#160;</a></span>links()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt; </div>
<table class="memname">
<tr>
<td class="memname">auto <a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html">ripple::test::csf::BasicNetwork</a>&lt; <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt;::links </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> const &amp;&#160;</td>
<td class="paramname"><em>from</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the range of active links. </p>
<dl class="section return"><dt>Returns</dt><dd>A random access range over <a class="el" href="structripple_1_1test_1_1csf_1_1Digraph_1_1Edge.html" title="Vertices and data associated with an Edge.">Digraph::Edge</a> instances </dd></dl>
<p class="definition">Definition at line <a class="el" href="BasicNetwork_8h_source.html#l00166">166</a> of file <a class="el" href="BasicNetwork_8h_source.html">BasicNetwork.h</a>.</p>
</div>
</div>
<a id="ab934937b6ad7b33ba73263045be4371c" name="ab934937b6ad7b33ba73263045be4371c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab934937b6ad7b33ba73263045be4371c">&#9670;&#160;</a></span>graph()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1test_1_1csf_1_1Digraph.html">Digraph</a>&lt; <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a>, <a class="el" href="structripple_1_1test_1_1csf_1_1BasicNetwork_1_1link__type.html">link_type</a> &gt; const &amp; <a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html">ripple::test::csf::BasicNetwork</a>&lt; <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt;::graph </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the underlying digraph. </p>
<p class="definition">Definition at line <a class="el" href="BasicNetwork_8h_source.html#l00174">174</a> of file <a class="el" href="BasicNetwork_8h_source.html">BasicNetwork.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a29a40079d51137ca15098e41df0f57ed" name="a29a40079d51137ca15098e41df0f57ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29a40079d51137ca15098e41df0f57ed">&#9670;&#160;</a></span>scheduler</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1test_1_1csf_1_1Scheduler.html">Scheduler</a>&amp; <a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html">ripple::test::csf::BasicNetwork</a>&lt; <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt;::scheduler</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BasicNetwork_8h_source.html#l00086">86</a> of file <a class="el" href="BasicNetwork_8h_source.html">BasicNetwork.h</a>.</p>
</div>
</div>
<a id="a97f7116d8ee44a3c122c272d77507f02" name="a97f7116d8ee44a3c122c272d77507f02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97f7116d8ee44a3c122c272d77507f02">&#9670;&#160;</a></span>links_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1test_1_1csf_1_1Digraph.html">Digraph</a>&lt;<a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a>, <a class="el" href="structripple_1_1test_1_1csf_1_1BasicNetwork_1_1link__type.html">link_type</a>&gt; <a class="el" href="classripple_1_1test_1_1csf_1_1BasicNetwork.html">ripple::test::csf::BasicNetwork</a>&lt; <a class="el" href="structripple_1_1test_1_1csf_1_1Peer.html">Peer</a> &gt;::links_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BasicNetwork_8h_source.html#l00087">87</a> of file <a class="el" href="BasicNetwork_8h_source.html">BasicNetwork.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated 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.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink