Files
rippled/PeerSet_8h_source.html
2021-01-21 18:53:50 +00:00

220 lines
33 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: PeerSet.h Source File</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="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_b003f5a72efe503c7552f86021e0c4d2.html">overlay</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">PeerSet.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">//==============================================================================</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#ifndef RIPPLE_APP_PEERS_PEERSET_H_INCLUDED</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define RIPPLE_APP_PEERS_PEERSET_H_INCLUDED</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;ripple/app/main/Application.h&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;ripple/beast/clock/abstract_clock.h&gt;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;ripple/beast/utility/Journal.h&gt;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;ripple/overlay/Peer.h&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;boost/asio/basic_waitable_timer.hpp&gt;</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/mutex.html">mutex</a>&gt;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/set.html">set</a>&gt;</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classripple_1_1PeerSet.html"> 48</a></span>&#160;<span class="keyword">class </span><a class="code" href="classripple_1_1PeerSet.html">PeerSet</a></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;{</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classripple_1_1PeerSet.html#a90a3672f3016e5d1c6128061879ec41e"> 51</a></span>&#160; <span class="keyword">using</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/thread/unique_lock.html">ScopedLockType</a> = <a class="codeRef" href="http://en.cppreference.com/w/cpp/thread/unique_lock.html">std::unique_lock&lt;std::recursive_mutex&gt;</a>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <a class="code" href="classripple_1_1PeerSet.html#a496be98fd2d19b2e01c9495c8ff3d069">PeerSet</a>(</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <a class="code" href="classripple_1_1Application.html">Application</a>&amp; app,</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <a class="code" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp; hash,</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::milliseconds</a> interval,</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <a class="code" href="classbeast_1_1Journal.html">beast::Journal</a> journal);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classripple_1_1PeerSet.html#a22815d04e8927297736623dbfafa24a6">~PeerSet</a>() = 0;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">void</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <a class="code" href="classripple_1_1PeerSet.html#a4557b201391f7d1b5e11af49560ff3ee">addPeers</a>(</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> limit,</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt;<span class="keywordtype">bool</span>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;Peer&gt;</a> <span class="keyword">const</span>&amp;)&gt; score);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <a class="code" href="classripple_1_1PeerSet.html#a9ce55399eb28bc79e4397b7455af8aec">onPeerAdded</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;Peer&gt;</a> <span class="keyword">const</span>&amp;) = 0;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <a class="code" href="classripple_1_1PeerSet.html#ac0416d2dcd2e5eb8801f55b03f4875e1">onTimer</a>(<span class="keywordtype">bool</span> progress, <a class="codeRef" href="http://en.cppreference.com/w/cpp/thread/unique_lock.html">ScopedLockType</a>&amp;) = 0;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <a class="code" href="classripple_1_1PeerSet.html#a46bc82ece5fd76d43a6206fa7714d13b">queueJob</a>() = 0;</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keyword">virtual</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/weak_ptr.html">std::weak_ptr&lt;PeerSet&gt;</a></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <a class="code" href="classripple_1_1PeerSet.html#af1c64f5cd21f67f9e232c42195aed820">pmDowncast</a>() = 0;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keywordtype">bool</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="classripple_1_1PeerSet.html#a92cd86e610ddc3c75bfa4a613dd42285"> 84</a></span>&#160; <a class="code" href="classripple_1_1PeerSet.html#a92cd86e610ddc3c75bfa4a613dd42285">isDone</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classripple_1_1PeerSet.html#a5e8e26a4201b05c805959c7fc909ec84">mComplete</a> || <a class="code" href="classripple_1_1PeerSet.html#a9a7d358bfb4c9ca39cbe143a270d6123">mFailed</a>;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; }</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keywordtype">void</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <a class="code" href="classripple_1_1PeerSet.html#af519e54b016eff0b244aceba65944e55">invokeOnTimer</a>();</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keywordtype">void</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <a class="code" href="classripple_1_1PeerSet.html#abb0ae391c3b73fdb47a4bca7069b97f4">sendRequest</a>(</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keyword">const</span> protocol::TMGetLedger&amp; message,</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;Peer&gt;</a> <span class="keyword">const</span>&amp; peer);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keywordtype">void</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <a class="code" href="classripple_1_1PeerSet.html#addc5e94d9df5ad4a25e9afb735984cf3">setTimer</a>();</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="comment">// Used in this class for access to boost::asio::io_service and</span></div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; <span class="comment">// ripple::Overlay. Used in subtypes for the kitchen sink.</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="classripple_1_1PeerSet.html#a706a011ba681781598055237f2d7fdaf"> 105</a></span>&#160; <a class="code" href="classripple_1_1Application.html">Application</a>&amp; <a class="code" href="classripple_1_1PeerSet.html#a706a011ba681781598055237f2d7fdaf">app_</a>;</div>
<div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="classripple_1_1PeerSet.html#a63e0e407163a2e3f9fcd9135f519b5d1"> 106</a></span>&#160; <a class="code" href="classbeast_1_1Journal.html">beast::Journal</a> <a class="code" href="classripple_1_1PeerSet.html#a63e0e407163a2e3f9fcd9135f519b5d1">m_journal</a>;</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; </div>
<div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="classripple_1_1PeerSet.html#ab4fa0ea92f95d96e69d2149e23d02ea4"> 108</a></span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html">std::recursive_mutex</a> <a class="code" href="classripple_1_1PeerSet.html#ab4fa0ea92f95d96e69d2149e23d02ea4">mLock</a>;</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; </div>
<div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="classripple_1_1PeerSet.html#a0a79a33d6012ccbc0f7e21e561d8f113"> 112</a></span>&#160; <a class="code" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span> <a class="code" href="classripple_1_1PeerSet.html#a0a79a33d6012ccbc0f7e21e561d8f113">mHash</a>;</div>
<div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="classripple_1_1PeerSet.html#ae9b6f50ad29c4a6838652f98d5cca7e3"> 113</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="classripple_1_1PeerSet.html#ae9b6f50ad29c4a6838652f98d5cca7e3">mTimeouts</a>;</div>
<div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="classripple_1_1PeerSet.html#a5e8e26a4201b05c805959c7fc909ec84"> 114</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classripple_1_1PeerSet.html#a5e8e26a4201b05c805959c7fc909ec84">mComplete</a>;</div>
<div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="classripple_1_1PeerSet.html#a9a7d358bfb4c9ca39cbe143a270d6123"> 115</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classripple_1_1PeerSet.html#a9a7d358bfb4c9ca39cbe143a270d6123">mFailed</a>;</div>
<div class="line"><a name="l00117"></a><span class="lineno"><a class="line" href="classripple_1_1PeerSet.html#ab291c226238498bf28b4ffad090b47e1"> 117</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classripple_1_1PeerSet.html#ab291c226238498bf28b4ffad090b47e1">mProgress</a>;</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; </div>
<div class="line"><a name="l00120"></a><span class="lineno"><a class="line" href="classripple_1_1PeerSet.html#a0652998669e63104bf8da3c0eafbe270"> 120</a></span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/container/set.html">std::set&lt;Peer::id_t&gt;</a> <a class="code" href="classripple_1_1PeerSet.html#a0652998669e63104bf8da3c0eafbe270">mPeers</a>;</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; </div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00124"></a><span class="lineno"><a class="line" href="classripple_1_1PeerSet.html#a6c83fd1c266d3fa99adb07d0075f201c"> 124</a></span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::milliseconds</a> <a class="code" href="classripple_1_1PeerSet.html#a6c83fd1c266d3fa99adb07d0075f201c">mTimerInterval</a>;</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <span class="comment">// VFALCO TODO move the responsibility for the timer to a higher level</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="classripple_1_1PeerSet.html#afab2c5b6dc398605d06502c282f11b56"> 126</a></span>&#160; boost::asio::basic_waitable_timer&lt;std::chrono::steady_clock&gt; <a class="code" href="classripple_1_1PeerSet.html#afab2c5b6dc398605d06502c282f11b56">mTimer</a>;</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;};</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; </div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;} <span class="comment">// namespace ripple</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; </div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassripple_1_1Application_html"><div class="ttname"><a href="classripple_1_1Application.html">ripple::Application</a></div><div class="ttdef"><b>Definition:</b> <a href="Application_8h_source.html#l00101">Application.h:101</a></div></div>
<div class="ttc" id="ashared_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a></div><div class="ttdoc">STL class.</div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_ac0416d2dcd2e5eb8801f55b03f4875e1"><div class="ttname"><a href="classripple_1_1PeerSet.html#ac0416d2dcd2e5eb8801f55b03f4875e1">ripple::PeerSet::onTimer</a></div><div class="ttdeci">virtual void onTimer(bool progress, ScopedLockType &amp;)=0</div><div class="ttdoc">Hook called from invokeOnTimer().</div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_ab291c226238498bf28b4ffad090b47e1"><div class="ttname"><a href="classripple_1_1PeerSet.html#ab291c226238498bf28b4ffad090b47e1">ripple::PeerSet::mProgress</a></div><div class="ttdeci">bool mProgress</div><div class="ttdoc">Whether forward progress has been made.</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8h_source.html#l00117">PeerSet.h:117</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_a92cd86e610ddc3c75bfa4a613dd42285"><div class="ttname"><a href="classripple_1_1PeerSet.html#a92cd86e610ddc3c75bfa4a613dd42285">ripple::PeerSet::isDone</a></div><div class="ttdeci">bool isDone() const</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8h_source.html#l00084">PeerSet.h:84</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_af519e54b016eff0b244aceba65944e55"><div class="ttname"><a href="classripple_1_1PeerSet.html#af519e54b016eff0b244aceba65944e55">ripple::PeerSet::invokeOnTimer</a></div><div class="ttdeci">void invokeOnTimer()</div><div class="ttdoc">Calls onTimer() if in the right state.</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8cpp_source.html#l00101">PeerSet.cpp:101</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_afab2c5b6dc398605d06502c282f11b56"><div class="ttname"><a href="classripple_1_1PeerSet.html#afab2c5b6dc398605d06502c282f11b56">ripple::PeerSet::mTimer</a></div><div class="ttdeci">boost::asio::basic_waitable_timer&lt; std::chrono::steady_clock &gt; mTimer</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8h_source.html#l00126">PeerSet.h:126</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_a0652998669e63104bf8da3c0eafbe270"><div class="ttname"><a href="classripple_1_1PeerSet.html#a0652998669e63104bf8da3c0eafbe270">ripple::PeerSet::mPeers</a></div><div class="ttdeci">std::set&lt; Peer::id_t &gt; mPeers</div><div class="ttdoc">The identifiers of the peers we are tracking.</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8h_source.html#l00120">PeerSet.h:120</a></div></div>
<div class="ttc" id="aduration_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::milliseconds</a></div></div>
<div class="ttc" id="arecursive_mutex_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html">std::recursive_mutex</a></div><div class="ttdoc">STL class.</div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_a5e8e26a4201b05c805959c7fc909ec84"><div class="ttname"><a href="classripple_1_1PeerSet.html#a5e8e26a4201b05c805959c7fc909ec84">ripple::PeerSet::mComplete</a></div><div class="ttdeci">bool mComplete</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8h_source.html#l00114">PeerSet.h:114</a></div></div>
<div class="ttc" id="afunction_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_a46bc82ece5fd76d43a6206fa7714d13b"><div class="ttname"><a href="classripple_1_1PeerSet.html#a46bc82ece5fd76d43a6206fa7714d13b">ripple::PeerSet::queueJob</a></div><div class="ttdeci">virtual void queueJob()=0</div><div class="ttdoc">Queue a job to call invokeOnTimer().</div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_a4557b201391f7d1b5e11af49560ff3ee"><div class="ttname"><a href="classripple_1_1PeerSet.html#a4557b201391f7d1b5e11af49560ff3ee">ripple::PeerSet::addPeers</a></div><div class="ttdeci">void addPeers(std::size_t limit, std::function&lt; bool(std::shared_ptr&lt; Peer &gt; const &amp;)&gt; score)</div><div class="ttdoc">Add at most limit peers to this set from the overlay.</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8cpp_source.html#l00050">PeerSet.cpp:50</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_a0a79a33d6012ccbc0f7e21e561d8f113"><div class="ttname"><a href="classripple_1_1PeerSet.html#a0a79a33d6012ccbc0f7e21e561d8f113">ripple::PeerSet::mHash</a></div><div class="ttdeci">const uint256 mHash</div><div class="ttdoc">The hash of the object (in practice, always a ledger) we are trying to fetch.</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8h_source.html#l00112">PeerSet.h:112</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_abb0ae391c3b73fdb47a4bca7069b97f4"><div class="ttname"><a href="classripple_1_1PeerSet.html#abb0ae391c3b73fdb47a4bca7069b97f4">ripple::PeerSet::sendRequest</a></div><div class="ttdeci">void sendRequest(const protocol::TMGetLedger &amp;message, std::shared_ptr&lt; Peer &gt; const &amp;peer)</div><div class="ttdoc">Send a GetLedger message to one or all peers.</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8cpp_source.html#l00127">PeerSet.cpp:127</a></div></div>
<div class="ttc" id="aclassripple_1_1base__uint_html"><div class="ttname"><a href="classripple_1_1base__uint.html">ripple::base_uint&lt; 256 &gt;</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_a22815d04e8927297736623dbfafa24a6"><div class="ttname"><a href="classripple_1_1PeerSet.html#a22815d04e8927297736623dbfafa24a6">ripple::PeerSet::~PeerSet</a></div><div class="ttdeci">virtual ~PeerSet()=0</div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_a496be98fd2d19b2e01c9495c8ff3d069"><div class="ttname"><a href="classripple_1_1PeerSet.html#a496be98fd2d19b2e01c9495c8ff3d069">ripple::PeerSet::PeerSet</a></div><div class="ttdeci">PeerSet(Application &amp;app, uint256 const &amp;hash, std::chrono::milliseconds interval, beast::Journal journal)</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8cpp_source.html#l00029">PeerSet.cpp:29</a></div></div>
<div class="ttc" id="aunique_lock_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/thread/unique_lock.html">std::unique_lock&lt; std::recursive_mutex &gt;</a></div></div>
<div class="ttc" id="aclassbeast_1_1Journal_html"><div class="ttname"><a href="classbeast_1_1Journal.html">beast::Journal</a></div><div class="ttdoc">A generic endpoint for log messages.</div><div class="ttdef"><b>Definition:</b> <a href="Journal_8h_source.html#l00058">Journal.h:58</a></div></div>
<div class="ttc" id="aweak_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/weak_ptr.html">std::weak_ptr</a></div><div class="ttdoc">STL class.</div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition:</b> <a href="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_a706a011ba681781598055237f2d7fdaf"><div class="ttname"><a href="classripple_1_1PeerSet.html#a706a011ba681781598055237f2d7fdaf">ripple::PeerSet::app_</a></div><div class="ttdeci">Application &amp; app_</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8h_source.html#l00105">PeerSet.h:105</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html"><div class="ttname"><a href="classripple_1_1PeerSet.html">ripple::PeerSet</a></div><div class="ttdoc">Supports data retrieval by managing a set of peers.</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8h_source.html#l00048">PeerSet.h:48</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_a9a7d358bfb4c9ca39cbe143a270d6123"><div class="ttname"><a href="classripple_1_1PeerSet.html#a9a7d358bfb4c9ca39cbe143a270d6123">ripple::PeerSet::mFailed</a></div><div class="ttdeci">bool mFailed</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8h_source.html#l00115">PeerSet.h:115</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_a9ce55399eb28bc79e4397b7455af8aec"><div class="ttname"><a href="classripple_1_1PeerSet.html#a9ce55399eb28bc79e4397b7455af8aec">ripple::PeerSet::onPeerAdded</a></div><div class="ttdeci">virtual void onPeerAdded(std::shared_ptr&lt; Peer &gt; const &amp;)=0</div><div class="ttdoc">Hook called from addPeers().</div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_a6c83fd1c266d3fa99adb07d0075f201c"><div class="ttname"><a href="classripple_1_1PeerSet.html#a6c83fd1c266d3fa99adb07d0075f201c">ripple::PeerSet::mTimerInterval</a></div><div class="ttdeci">std::chrono::milliseconds mTimerInterval</div><div class="ttdoc">The minimum time to wait between calls to execute().</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8h_source.html#l00124">PeerSet.h:124</a></div></div>
<div class="ttc" id="amutex_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/mutex.html">mutex</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_a63e0e407163a2e3f9fcd9135f519b5d1"><div class="ttname"><a href="classripple_1_1PeerSet.html#a63e0e407163a2e3f9fcd9135f519b5d1">ripple::PeerSet::m_journal</a></div><div class="ttdeci">beast::Journal m_journal</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8h_source.html#l00106">PeerSet.h:106</a></div></div>
<div class="ttc" id="asize_t_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_ae9b6f50ad29c4a6838652f98d5cca7e3"><div class="ttname"><a href="classripple_1_1PeerSet.html#ae9b6f50ad29c4a6838652f98d5cca7e3">ripple::PeerSet::mTimeouts</a></div><div class="ttdeci">int mTimeouts</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8h_source.html#l00113">PeerSet.h:113</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_af1c64f5cd21f67f9e232c42195aed820"><div class="ttname"><a href="classripple_1_1PeerSet.html#af1c64f5cd21f67f9e232c42195aed820">ripple::PeerSet::pmDowncast</a></div><div class="ttdeci">virtual std::weak_ptr&lt; PeerSet &gt; pmDowncast()=0</div><div class="ttdoc">Return a weak pointer to this.</div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_addc5e94d9df5ad4a25e9afb735984cf3"><div class="ttname"><a href="classripple_1_1PeerSet.html#addc5e94d9df5ad4a25e9afb735984cf3">ripple::PeerSet::setTimer</a></div><div class="ttdeci">void setTimer()</div><div class="ttdoc">Schedule a call to queueJob() after mTimerInterval.</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8cpp_source.html#l00087">PeerSet.cpp:87</a></div></div>
<div class="ttc" id="aset_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/set.html">set</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerSet_html_ab4fa0ea92f95d96e69d2149e23d02ea4"><div class="ttname"><a href="classripple_1_1PeerSet.html#ab4fa0ea92f95d96e69d2149e23d02ea4">ripple::PeerSet::mLock</a></div><div class="ttdeci">std::recursive_mutex mLock</div><div class="ttdef"><b>Definition:</b> <a href="PeerSet_8h_source.html#l00108">PeerSet.h:108</a></div></div>
<!-- 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>