Files
rippled/structripple_1_1test_1_1csf_1_1CollectByNode.html
2021-03-12 22:34:28 +00:00

229 lines
13 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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</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>
<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="#ripple_1_1test_1_1csf_1_1CollectByNode_3_01CollectorType_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1test_1_1csf_1_1CollectByNode_3_01CollectorType_01_4_coll__map" id="ripple_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="1004,134,1240,175"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="709,127,901,183"/>
<area shape="rect" href="classripple_1_1tagged__integer.html" title=" " alt="" coords="419,134,625,175"/>
<area shape="rect" title=" " alt="" coords="5,5,309,179"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="106,203,209,229"/>
</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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af82159c8aa4d63f3c46a5ca35c3cf489"><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#af82159c8aa4d63f3c46a5ca35c3cf489">operator[]</a> (<a class="el" href="namespaceripple_1_1test_1_1csf.html#a1a320722bad8a720a9497b656493dd50">PeerID</a> who)</td></tr>
<tr class="separator:af82159c8aa4d63f3c46a5ca35c3cf489"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae24eb30e3da6ef323af276fe0022555c"><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#ae24eb30e3da6ef323af276fe0022555c">operator[]</a> (<a class="el" href="namespaceripple_1_1test_1_1csf.html#a1a320722bad8a720a9497b656493dd50">PeerID</a> who) const</td></tr>
<tr class="separator:ae24eb30e3da6ef323af276fe0022555c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem: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 name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem: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"><h3>template&lt;class CollectorType&gt;<br />
struct ripple::test::csf::CollectByNode&lt; CollectorType &gt;</h3>
<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#l00110">110</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="af82159c8aa4d63f3c46a5ca35c3cf489"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af82159c8aa4d63f3c46a5ca35c3cf489">&#9670;&nbsp;</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#l00115">115</a> of file <a class="el" href="collectors_8h_source.html">collectors.h</a>.</p>
</div>
</div>
<a id="ae24eb30e3da6ef323af276fe0022555c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae24eb30e3da6ef323af276fe0022555c">&#9670;&nbsp;</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#l00121">121</a> of file <a class="el" href="collectors_8h_source.html">collectors.h</a>.</p>
</div>
</div>
<a id="a620a795fbd551d868035970f99e4f584"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a620a795fbd551d868035970f99e4f584">&#9670;&nbsp;</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#l00127">127</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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7dc801054b4ffa1402167a029c068a27">&#9670;&nbsp;</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#l00112">112</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="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>