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

164 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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: Fixed.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 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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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="dir_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_89046728185f0c274a4164d3e2cb38fb.html">peerfinder</a></li><li class="navelem"><a class="el" href="dir_e9607b4c59cebecf2224e361d8d6d362.html">detail</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">Fixed.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef XRPL_PEERFINDER_FIXED_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_PEERFINDER_FIXED_H_INCLUDED</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpld/peerfinder/detail/Tuning.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">namespace </span>PeerFinder {</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="foldopen" id="foldopen00010" data-start="{" data-end="};">
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Fixed.html"> 10</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1PeerFinder_1_1Fixed.html">Fixed</a></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span>{</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">public</span>:</div>
<div class="foldopen" id="foldopen00013" data-start="{" data-end="}">
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Fixed.html#af8c354a3d2ab4abffbaa30b6677e0e45"> 13</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classripple_1_1PeerFinder_1_1Fixed.html#af8c354a3d2ab4abffbaa30b6677e0e45">Fixed</a>(<a class="code hl_class" href="classbeast_1_1abstract__clock.html">clock_type</a>&amp; clock) : <a class="code hl_variable" href="classripple_1_1PeerFinder_1_1Fixed.html#a46faebd61d3d45de66bb08c1384142ab">m_when</a>(clock.now()), <a class="code hl_variable" href="classripple_1_1PeerFinder_1_1Fixed.html#ae79d8f907dbc172093445f68b051de24">m_failures</a>(0)</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> {</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> }</div>
</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Fixed.html#abfc5ed99f8b318d9dc54e913dd8ff43e"> 17</a></span> <a class="code hl_function" href="classripple_1_1PeerFinder_1_1Fixed.html#abfc5ed99f8b318d9dc54e913dd8ff43e">Fixed</a>(<a class="code hl_class" href="classripple_1_1PeerFinder_1_1Fixed.html">Fixed</a> <span class="keyword">const</span>&amp;) = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_typedef" href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">clock_type::time_point</a> <span class="keyword">const</span>&amp;</div>
<div class="foldopen" id="foldopen00021" data-start="{" data-end="}">
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Fixed.html#a2453775b85f077716958a986698aea67"> 21</a></span> <a class="code hl_function" href="classripple_1_1PeerFinder_1_1Fixed.html#a2453775b85f077716958a986698aea67">when</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classripple_1_1PeerFinder_1_1Fixed.html#a46faebd61d3d45de66bb08c1384142ab">m_when</a>;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> }</div>
</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00028" data-start="{" data-end="}">
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Fixed.html#ad2c4872213cb93da59d64f6374bdc66d"> 28</a></span> <a class="code hl_function" href="classripple_1_1PeerFinder_1_1Fixed.html#ad2c4872213cb93da59d64f6374bdc66d">failure</a>(<a class="code hl_typedef" href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">clock_type::time_point</a> <span class="keyword">const</span>&amp; now)</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> {</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <a class="code hl_variable" href="classripple_1_1PeerFinder_1_1Fixed.html#ae79d8f907dbc172093445f68b051de24">m_failures</a> =</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/algorithm/min.html">std::min</a>(<a class="code hl_variable" href="classripple_1_1PeerFinder_1_1Fixed.html#ae79d8f907dbc172093445f68b051de24">m_failures</a> + 1, <a class="code hl_variable" href="namespaceripple_1_1PeerFinder_1_1Tuning.html#ad46089ab9429a4c94c965ab519454410">Tuning::connectionBackoff</a>.size() - 1);</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <a class="code hl_variable" href="classripple_1_1PeerFinder_1_1Fixed.html#a46faebd61d3d45de66bb08c1384142ab">m_when</a> =</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> now + <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::minutes</a>(<a class="code hl_variable" href="namespaceripple_1_1PeerFinder_1_1Tuning.html#ad46089ab9429a4c94c965ab519454410">Tuning::connectionBackoff</a>[<a class="code hl_variable" href="classripple_1_1PeerFinder_1_1Fixed.html#ae79d8f907dbc172093445f68b051de24">m_failures</a>]);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> }</div>
</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00038" data-start="{" data-end="}">
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Fixed.html#ad703ac09879fa69ca642ddaae44b3051"> 38</a></span> <a class="code hl_function" href="classripple_1_1PeerFinder_1_1Fixed.html#ad703ac09879fa69ca642ddaae44b3051">success</a>(<a class="code hl_typedef" href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">clock_type::time_point</a> <span class="keyword">const</span>&amp; now)</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> {</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_variable" href="classripple_1_1PeerFinder_1_1Fixed.html#ae79d8f907dbc172093445f68b051de24">m_failures</a> = 0;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <a class="code hl_variable" href="classripple_1_1PeerFinder_1_1Fixed.html#a46faebd61d3d45de66bb08c1384142ab">m_when</a> = now;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> }</div>
</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Fixed.html#a46faebd61d3d45de66bb08c1384142ab"> 45</a></span> <a class="code hl_typedef" href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">clock_type::time_point</a> <a class="code hl_variable" href="classripple_1_1PeerFinder_1_1Fixed.html#a46faebd61d3d45de66bb08c1384142ab">m_when</a>;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Fixed.html#ae79d8f907dbc172093445f68b051de24"> 46</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> <a class="code hl_variable" href="classripple_1_1PeerFinder_1_1Fixed.html#ae79d8f907dbc172093445f68b051de24">m_failures</a>;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span>};</div>
</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span>} <span class="comment">// namespace PeerFinder</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassbeast_1_1abstract__clock_html"><div class="ttname"><a href="classbeast_1_1abstract__clock.html">beast::abstract_clock&lt; std::chrono::steady_clock &gt;</a></div></div>
<div class="ttc" id="aclassbeast_1_1abstract__clock_html_a4e16832b0bdf9392c5138bbbde024d8e"><div class="ttname"><a href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">beast::abstract_clock&lt; std::chrono::steady_clock &gt;::time_point</a></div><div class="ttdeci">typename Clock::time_point time_point</div><div class="ttdef"><b>Definition</b> <a href="abstract__clock_8h_source.html#l00041">abstract_clock.h:41</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerFinder_1_1Fixed_html"><div class="ttname"><a href="classripple_1_1PeerFinder_1_1Fixed.html">ripple::PeerFinder::Fixed</a></div><div class="ttdoc">Metadata for a Fixed slot.</div><div class="ttdef"><b>Definition</b> <a href="Fixed_8h_source.html#l00010">Fixed.h:11</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerFinder_1_1Fixed_html_a2453775b85f077716958a986698aea67"><div class="ttname"><a href="classripple_1_1PeerFinder_1_1Fixed.html#a2453775b85f077716958a986698aea67">ripple::PeerFinder::Fixed::when</a></div><div class="ttdeci">clock_type::time_point const &amp; when() const</div><div class="ttdoc">Returns the time after which we shoud allow a connection attempt.</div><div class="ttdef"><b>Definition</b> <a href="Fixed_8h_source.html#l00021">Fixed.h:21</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerFinder_1_1Fixed_html_a46faebd61d3d45de66bb08c1384142ab"><div class="ttname"><a href="classripple_1_1PeerFinder_1_1Fixed.html#a46faebd61d3d45de66bb08c1384142ab">ripple::PeerFinder::Fixed::m_when</a></div><div class="ttdeci">clock_type::time_point m_when</div><div class="ttdef"><b>Definition</b> <a href="Fixed_8h_source.html#l00045">Fixed.h:45</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerFinder_1_1Fixed_html_abfc5ed99f8b318d9dc54e913dd8ff43e"><div class="ttname"><a href="classripple_1_1PeerFinder_1_1Fixed.html#abfc5ed99f8b318d9dc54e913dd8ff43e">ripple::PeerFinder::Fixed::Fixed</a></div><div class="ttdeci">Fixed(Fixed const &amp;)=default</div></div>
<div class="ttc" id="aclassripple_1_1PeerFinder_1_1Fixed_html_ad2c4872213cb93da59d64f6374bdc66d"><div class="ttname"><a href="classripple_1_1PeerFinder_1_1Fixed.html#ad2c4872213cb93da59d64f6374bdc66d">ripple::PeerFinder::Fixed::failure</a></div><div class="ttdeci">void failure(clock_type::time_point const &amp;now)</div><div class="ttdoc">Updates metadata to reflect a failed connection.</div><div class="ttdef"><b>Definition</b> <a href="Fixed_8h_source.html#l00028">Fixed.h:28</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerFinder_1_1Fixed_html_ad703ac09879fa69ca642ddaae44b3051"><div class="ttname"><a href="classripple_1_1PeerFinder_1_1Fixed.html#ad703ac09879fa69ca642ddaae44b3051">ripple::PeerFinder::Fixed::success</a></div><div class="ttdeci">void success(clock_type::time_point const &amp;now)</div><div class="ttdoc">Updates metadata to reflect a successful connection.</div><div class="ttdef"><b>Definition</b> <a href="Fixed_8h_source.html#l00038">Fixed.h:38</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerFinder_1_1Fixed_html_ae79d8f907dbc172093445f68b051de24"><div class="ttname"><a href="classripple_1_1PeerFinder_1_1Fixed.html#ae79d8f907dbc172093445f68b051de24">ripple::PeerFinder::Fixed::m_failures</a></div><div class="ttdeci">std::size_t m_failures</div><div class="ttdef"><b>Definition</b> <a href="Fixed_8h_source.html#l00046">Fixed.h:46</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerFinder_1_1Fixed_html_af8c354a3d2ab4abffbaa30b6677e0e45"><div class="ttname"><a href="classripple_1_1PeerFinder_1_1Fixed.html#af8c354a3d2ab4abffbaa30b6677e0e45">ripple::PeerFinder::Fixed::Fixed</a></div><div class="ttdeci">Fixed(clock_type &amp;clock)</div><div class="ttdef"><b>Definition</b> <a href="Fixed_8h_source.html#l00013">Fixed.h:13</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::minutes</a></div></div>
<div class="ttc" id="amin_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/algorithm/min.html">std::min</a></div><div class="ttdeci">T min(T... args)</div></div>
<div class="ttc" id="anamespaceripple_1_1PeerFinder_1_1Tuning_html_ad46089ab9429a4c94c965ab519454410"><div class="ttname"><a href="namespaceripple_1_1PeerFinder_1_1Tuning.html#ad46089ab9429a4c94c965ab519454410">ripple::PeerFinder::Tuning::connectionBackoff</a></div><div class="ttdeci">static std::array&lt; int, 10 &gt; const connectionBackoff</div><div class="ttdef"><b>Definition</b> <a href="src_2xrpld_2peerfinder_2detail_2Tuning_8h_source.html#l00060">src/xrpld/peerfinder/detail/Tuning.h:60</a></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="algorithm_8h_source.html#l00006">algorithm.h:6</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><!-- fragment --></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>