Files
rippled/structripple_1_1test_1_1csf_1_1CollectByNode.html
2025-11-04 00:36:48 -08:00

236 lines
14 KiB
HTML

<!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::CollectByNode&lt; CollectorType &gt; Struct 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="structripple_1_1test_1_1csf_1_1CollectByNode.html">CollectByNode</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structripple_1_1test_1_1csf_1_1CollectByNode-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::test::csf::CollectByNode&lt; CollectorType &gt; Struct Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Maintain an instance of a Collector per peer.
<a href="structripple_1_1test_1_1csf_1_1CollectByNode.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="collectors_8h_source.html">collectors.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::test::csf::CollectByNode&lt; CollectorType &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1test_1_1csf_1_1CollectByNode__coll__graph.png" border="0" usemap="#aripple_1_1test_1_1csf_1_1CollectByNode_3_01CollectorType_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1test_1_1csf_1_1CollectByNode_3_01CollectorType_01_4_coll__map" id="aripple_1_1test_1_1csf_1_1CollectByNode_3_01CollectorType_01_4_coll__map">
<area shape="rect" title="Maintain an instance of a Collector per peer." alt="" coords="879,57,1115,97"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="589,57,776,97"/>
<area shape="poly" title=" " alt="" coords="790,74,879,74,879,79,790,79"/>
<area shape="rect" href="classripple_1_1tagged__integer.html" title="A type&#45;safe wrap around standard integral types." alt="" coords="341,57,507,97"/>
<area shape="poly" title=" " alt="" coords="520,74,589,74,589,79,520,79"/>
<area shape="rect" title=" " alt="" coords="5,5,292,148"/>
<area shape="poly" title=" " alt="" coords="306,74,341,74,341,79,306,79"/>
</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="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a80f1538ab5a2c7e13746bb1aeccabeb6" id="r_a80f1538ab5a2c7e13746bb1aeccabeb6"><td class="memItemLeft" align="right" valign="top">CollectorType &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1test_1_1csf_1_1CollectByNode.html#a80f1538ab5a2c7e13746bb1aeccabeb6">operator[]</a> (<a class="el" href="namespaceripple_1_1test_1_1csf.html#a1a320722bad8a720a9497b656493dd50">PeerID</a> who)</td></tr>
<tr class="separator:a80f1538ab5a2c7e13746bb1aeccabeb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01826bd7cc84f0c4f0df3b4a71255ba0" id="r_a01826bd7cc84f0c4f0df3b4a71255ba0"><td class="memItemLeft" align="right" valign="top">CollectorType const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1test_1_1csf_1_1CollectByNode.html#a01826bd7cc84f0c4f0df3b4a71255ba0">operator[]</a> (<a class="el" href="namespaceripple_1_1test_1_1csf.html#a1a320722bad8a720a9497b656493dd50">PeerID</a> who) const</td></tr>
<tr class="separator:a01826bd7cc84f0c4f0df3b4a71255ba0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a620a795fbd551d868035970f99e4f584" id="r_a620a795fbd551d868035970f99e4f584"><td class="memTemplParams" colspan="2">template&lt;class E &gt; </td></tr>
<tr class="memitem:a620a795fbd551d868035970f99e4f584"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structripple_1_1test_1_1csf_1_1CollectByNode.html#a620a795fbd551d868035970f99e4f584">on</a> (<a class="el" href="namespaceripple_1_1test_1_1csf.html#a1a320722bad8a720a9497b656493dd50">PeerID</a> who, <a class="el" href="namespaceripple_1_1test_1_1csf.html#a94af4815b9aaf71de676cd8377415473">SimTime</a> when, E const &amp;e)</td></tr>
<tr class="separator:a620a795fbd551d868035970f99e4f584"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a7dc801054b4ffa1402167a029c068a27" id="r_a7dc801054b4ffa1402167a029c068a27"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/map.html">std::map</a>&lt; <a class="el" href="namespaceripple_1_1test_1_1csf.html#a1a320722bad8a720a9497b656493dd50">PeerID</a>, CollectorType &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1test_1_1csf_1_1CollectByNode.html#a7dc801054b4ffa1402167a029c068a27">byNode</a></td></tr>
<tr class="separator:a7dc801054b4ffa1402167a029c068a27"><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 CollectorType&gt;<br />
struct ripple::test::csf::CollectByNode&lt; CollectorType &gt;</div><p>Maintain an instance of a Collector per peer. </p>
<p>For each peer that emits events, this class maintains a corresponding instance of CollectorType, only forwarding events emitted by the peer to the related instance.</p>
<p>CollectorType should be default constructible. </p>
<p class="definition">Definition at line <a class="el" href="collectors_8h_source.html#l00093">93</a> of file <a class="el" href="collectors_8h_source.html">collectors.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a80f1538ab5a2c7e13746bb1aeccabeb6" name="a80f1538ab5a2c7e13746bb1aeccabeb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80f1538ab5a2c7e13746bb1aeccabeb6">&#9670;&#160;</a></span>operator[]() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class CollectorType &gt; </div>
<table class="memname">
<tr>
<td class="memname">CollectorType &amp; <a class="el" href="structripple_1_1test_1_1csf_1_1CollectByNode.html">ripple::test::csf::CollectByNode</a>&lt; CollectorType &gt;::operator[] </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple_1_1test_1_1csf.html#a1a320722bad8a720a9497b656493dd50">PeerID</a>&#160;</td>
<td class="paramname"><em>who</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="collectors_8h_source.html#l00098">98</a> of file <a class="el" href="collectors_8h_source.html">collectors.h</a>.</p>
</div>
</div>
<a id="a01826bd7cc84f0c4f0df3b4a71255ba0" name="a01826bd7cc84f0c4f0df3b4a71255ba0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01826bd7cc84f0c4f0df3b4a71255ba0">&#9670;&#160;</a></span>operator[]() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class CollectorType &gt; </div>
<table class="memname">
<tr>
<td class="memname">CollectorType const &amp; <a class="el" href="structripple_1_1test_1_1csf_1_1CollectByNode.html">ripple::test::csf::CollectByNode</a>&lt; CollectorType &gt;::operator[] </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple_1_1test_1_1csf.html#a1a320722bad8a720a9497b656493dd50">PeerID</a>&#160;</td>
<td class="paramname"><em>who</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="collectors_8h_source.html#l00104">104</a> of file <a class="el" href="collectors_8h_source.html">collectors.h</a>.</p>
</div>
</div>
<a id="a620a795fbd551d868035970f99e4f584" name="a620a795fbd551d868035970f99e4f584"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a620a795fbd551d868035970f99e4f584">&#9670;&#160;</a></span>on()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class CollectorType &gt; </div>
<div class="memtemplate">
template&lt;class E &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="structripple_1_1test_1_1csf_1_1CollectByNode.html">ripple::test::csf::CollectByNode</a>&lt; CollectorType &gt;::on </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple_1_1test_1_1csf.html#a1a320722bad8a720a9497b656493dd50">PeerID</a>&#160;</td>
<td class="paramname"><em>who</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple_1_1test_1_1csf.html#a94af4815b9aaf71de676cd8377415473">SimTime</a>&#160;</td>
<td class="paramname"><em>when</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">E const &amp;&#160;</td>
<td class="paramname"><em>e</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="collectors_8h_source.html#l00110">110</a> of file <a class="el" href="collectors_8h_source.html">collectors.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a7dc801054b4ffa1402167a029c068a27" name="a7dc801054b4ffa1402167a029c068a27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7dc801054b4ffa1402167a029c068a27">&#9670;&#160;</a></span>byNode</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class CollectorType &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/map.html">std::map</a>&lt;<a class="el" href="namespaceripple_1_1test_1_1csf.html#a1a320722bad8a720a9497b656493dd50">PeerID</a>, CollectorType&gt; <a class="el" href="structripple_1_1test_1_1csf_1_1CollectByNode.html">ripple::test::csf::CollectByNode</a>&lt; CollectorType &gt;::byNode</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="collectors_8h_source.html#l00095">95</a> of file <a class="el" href="collectors_8h_source.html">collectors.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>