Files
rippled/classripple_1_1OverlayImpl_1_1Child.html
2025-01-21 19:58:08 +00:00

292 lines
19 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.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::OverlayImpl::Child Class 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.5 -->
<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="classripple_1_1OverlayImpl.html">OverlayImpl</a></li><li class="navelem"><a class="el" href="classripple_1_1OverlayImpl_1_1Child.html">Child</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classripple_1_1OverlayImpl_1_1Child-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::OverlayImpl::Child Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="OverlayImpl_8h_source.html">OverlayImpl.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ripple::OverlayImpl::Child:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1OverlayImpl_1_1Child__inherit__graph.png" border="0" usemap="#aripple_1_1OverlayImpl_1_1Child_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1OverlayImpl_1_1Child_inherit__map" id="aripple_1_1OverlayImpl_1_1Child_inherit__map">
<area shape="rect" title=" " alt="" coords="203,5,349,45"/>
<area shape="rect" href="classripple_1_1ConnectAttempt.html" title="Manages an outbound connection attempt." alt="" coords="5,101,179,126"/>
<area shape="rect" href="structripple_1_1OverlayImpl_1_1Timer.html" title=" " alt="" coords="203,93,349,133"/>
<area shape="rect" href="classripple_1_1PeerImp.html" title=" " alt="" coords="374,101,495,126"/>
<area shape="rect" href="classripple_1_1test_1_1tx__reduce__relay__test_1_1PeerTest.html" title=" " alt="" coords="353,181,517,221"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ripple::OverlayImpl::Child:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1OverlayImpl_1_1Child__coll__graph.png" border="0" usemap="#aripple_1_1OverlayImpl_1_1Child_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1OverlayImpl_1_1Child_coll__map" id="aripple_1_1OverlayImpl_1_1Child_coll__map">
<area shape="rect" title=" " alt="" coords="315,51,461,91"/>
<area shape="rect" href="structripple_1_1OverlayImpl_1_1Timer.html" title=" " alt="" coords="767,12,913,52"/>
<area shape="rect" href="classripple_1_1OverlayImpl.html" title=" " alt="" coords="1620,1154,1767,1179"/>
<area shape="rect" href="classripple_1_1Overlay.html" title="Manages the set of connected peers." alt="" coords="1023,190,1141,215"/>
<area shape="rect" href="classbeast_1_1PropertyStream_1_1Source.html" title="Subclasses can be called to write to a stream and have children." alt="" coords="304,233,472,273"/>
<area shape="rect" href="classripple_1_1Application.html" title=" " alt="" coords="770,241,910,266"/>
<area shape="rect" href="classripple_1_1Resource_1_1Manager.html" title="Tracks load and resource consumption." alt="" coords="744,355,936,381"/>
<area shape="rect" href="classripple_1_1PeerFinder_1_1Manager.html" title="Maintains a set of IP addresses used for getting into the network." alt="" coords="772,291,908,331"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html" title=" " alt="" coords="5,166,164,191"/>
<area shape="rect" href="classripple_1_1reduce__relay_1_1SquelchHandler.html" title="Abstract class." alt="" coords="765,1256,915,1296"/>
<area shape="rect" href="classripple_1_1reduce__relay_1_1Slots.html" title=" " alt="" coords="1216,1323,1437,1363"/>
<area shape="rect" href="classripple_1_1ServerHandler.html" title=" " alt="" coords="1247,695,1407,721"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="1233,297,1420,337"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/condition_variable_any.html" title=" " alt="" coords="1226,362,1427,387"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/weak_ptr.html" title=" " alt="" coords="1241,12,1412,52"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="333,642,443,667"/>
<area shape="rect" href="classripple_1_1JobQueue.html" title="A pool of threads to perform work." alt="" coords="775,1001,905,1026"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="11,642,158,667"/>
<area shape="rect" href="classripple_1_1NetworkOPs.html" title="Provides server functionality for clients." alt="" coords="767,759,913,785"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html" title=" " alt="" coords="755,809,925,849"/>
<area shape="rect" href="structripple_1_1ServerHandler_1_1Setup.html" title=" " alt="" coords="760,873,920,913"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/mutex.html" title=" " alt="" coords="342,1522,434,1547"/>
<area shape="rect" href="classripple_1_1Logs.html" title="Manages partitions for logging." alt="" coords="791,1522,889,1547"/>
<area shape="rect" href="structripple_1_1metrics_1_1TxMetrics.html" title="Run transaction reduce&#45;relay feature related metrics." alt="" coords="1233,1861,1421,1886"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="33,1801,136,1826"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="523,1801,701,1826"/>
<area shape="rect" href="structripple_1_1metrics_1_1SingleMetrics.html" title="Run single metrics rolling average." alt="" coords="282,1962,494,1987"/>
<area shape="rect" href="classbeast_1_1insight_1_1Gauge.html" title="A metric for measuring an integral value." alt="" coords="308,1057,468,1082"/>
<area shape="rect" href="structripple_1_1OverlayImpl_1_1Stats.html" title=" " alt="" coords="767,1129,913,1169"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/condition_variable.html" title=" " alt="" coords="303,781,473,806"/>
<area shape="rect" href="classbeast_1_1insight_1_1Counter.html" title="A metric for measuring an integral value." alt="" coords="755,582,925,607"/>
<area shape="rect" href="classbeast_1_1insight_1_1Event.html" title="A metric for reporting event timing." alt="" coords="763,631,917,657"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="748,681,932,735"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html" title=" " alt="" coords="1237,412,1416,452"/>
<area shape="rect" href="classripple_1_1TrafficCount.html" title=" " alt="" coords="1255,1042,1399,1067"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="745,1050,935,1105"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="1209,1424,1444,1493"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="755,1572,925,1612"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/weak_ptr.html" title=" " alt="" coords="759,1687,921,1727"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="1209,1673,1444,1727"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="33,1963,136,1989"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="979,2133,1185,2158"/>
<area shape="rect" href="classripple_1_1Resolver.html" title=" " alt="" coords="1265,1518,1389,1543"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="725,1320,955,1389"/>
<area shape="rect" href="classbeast_1_1detail_1_1aged__unordered__container.html" title="Associative container where each element is also indexed by time." alt="" coords="745,1414,935,1498"/>
<area shape="rect" href="structripple_1_1metrics_1_1MultipleMetrics.html" title="Run two metrics." alt="" coords="751,2021,929,2061"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="1241,1911,1412,1951"/>
<area shape="rect" href="classripple_1_1Message.html" title=" " alt="" coords="777,2086,903,2111"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="1257,1975,1396,2015"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="277,1109,499,1149"/>
</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:ac4493bf690681e0f2aa3b597235f0361"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1OverlayImpl_1_1Child.html#ac4493bf690681e0f2aa3b597235f0361">stop</a> ()=0</td></tr>
<tr class="separator:ac4493bf690681e0f2aa3b597235f0361"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a92a7ada2284894883255d8c16e5c2d0f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1OverlayImpl_1_1Child.html#a92a7ada2284894883255d8c16e5c2d0f">Child</a> (<a class="el" href="classripple_1_1OverlayImpl.html">OverlayImpl</a> &amp;overlay)</td></tr>
<tr class="separator:a92a7ada2284894883255d8c16e5c2d0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5fc5099ae66aec0ae67166804a593a46"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1OverlayImpl_1_1Child.html#a5fc5099ae66aec0ae67166804a593a46">~Child</a> ()</td></tr>
<tr class="separator:a5fc5099ae66aec0ae67166804a593a46"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ac48a68b0e553ec566f03e3f7d538beec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1OverlayImpl.html">OverlayImpl</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1OverlayImpl_1_1Child.html#ac48a68b0e553ec566f03e3f7d538beec">overlay_</a></td></tr>
<tr class="separator:ac48a68b0e553ec566f03e3f7d538beec"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="OverlayImpl_8h_source.html#l00061">61</a> of file <a class="el" href="OverlayImpl_8h_source.html">OverlayImpl.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a92a7ada2284894883255d8c16e5c2d0f" name="a92a7ada2284894883255d8c16e5c2d0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92a7ada2284894883255d8c16e5c2d0f">&#9670;&#160;</a></span>Child()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::OverlayImpl::Child::Child </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1OverlayImpl.html">OverlayImpl</a> &amp;&#160;</td>
<td class="paramname"><em>overlay</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="OverlayImpl_8cpp_source.html#l00056">56</a> of file <a class="el" href="OverlayImpl_8cpp_source.html">OverlayImpl.cpp</a>.</p>
</div>
</div>
<a id="a5fc5099ae66aec0ae67166804a593a46" name="a5fc5099ae66aec0ae67166804a593a46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5fc5099ae66aec0ae67166804a593a46">&#9670;&#160;</a></span>~Child()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::OverlayImpl::Child::~Child </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="OverlayImpl_8cpp_source.html#l00060">60</a> of file <a class="el" href="OverlayImpl_8cpp_source.html">OverlayImpl.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac4493bf690681e0f2aa3b597235f0361" name="ac4493bf690681e0f2aa3b597235f0361"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4493bf690681e0f2aa3b597235f0361">&#9670;&#160;</a></span>stop()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::OverlayImpl::Child::stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classripple_1_1ConnectAttempt.html#a22c40c47432ec6abd8a108fea08b501e">ripple::ConnectAttempt</a>, <a class="el" href="structripple_1_1OverlayImpl_1_1Timer.html#a971696ae846cc8d14ae3c4e32eec5a2c">ripple::OverlayImpl::Timer</a>, and <a class="el" href="classripple_1_1PeerImp.html#a3b02a6f5908e5da544f876bd48614e4c">ripple::PeerImp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ac48a68b0e553ec566f03e3f7d538beec" name="ac48a68b0e553ec566f03e3f7d538beec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac48a68b0e553ec566f03e3f7d538beec">&#9670;&#160;</a></span>overlay_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1OverlayImpl.html">OverlayImpl</a>&amp; ripple::OverlayImpl::Child::overlay_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="OverlayImpl_8h_source.html#l00064">64</a> of file <a class="el" href="OverlayImpl_8h_source.html">OverlayImpl.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.5
</small></address>
</body>
</html>