This commit is contained in:
nbougalis
2020-04-15 21:15:02 +00:00
commit 4ad595bf18
12373 changed files with 1478990 additions and 0 deletions

160
Fixed_8h_source.html Normal file
View File

@@ -0,0 +1,160 @@
<!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: 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 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_44aff85a5b558cac9311bb222eb8fa78.html">peerfinder</a></li><li class="navelem"><a class="el" href="dir_01f812eedbcff88039c2ca147e9e73a6.html">impl</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 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_PEERFINDER_FIXED_H_INCLUDED</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define RIPPLE_PEERFINDER_FIXED_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/peerfinder/impl/Tuning.h&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">namespace </span>PeerFinder {</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Fixed.html"> 29</a></span>&#160;<span class="keyword">class </span><a class="code" href="classripple_1_1PeerFinder_1_1Fixed.html">Fixed</a></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">public</span>:</div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Fixed.html#af8c354a3d2ab4abffbaa30b6677e0e45"> 32</a></span>&#160; <span class="keyword">explicit</span> <a class="code" href="classripple_1_1PeerFinder_1_1Fixed.html#af8c354a3d2ab4abffbaa30b6677e0e45">Fixed</a> (<a class="code" href="classbeast_1_1abstract__clock.html">clock_type</a>&amp; clock)</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; : <a class="code" href="classripple_1_1PeerFinder_1_1Fixed.html#a46faebd61d3d45de66bb08c1384142ab">m_when</a> (clock.now ())</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; , <a class="code" href="classripple_1_1PeerFinder_1_1Fixed.html#ae79d8f907dbc172093445f68b051de24">m_failures</a> (0)</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; {</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; }</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="classripple_1_1PeerFinder_1_1Fixed.html#af8c354a3d2ab4abffbaa30b6677e0e45">Fixed</a> (<a class="code" 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 name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Fixed.html#a26ea4d7cb7efbbdd51dcf11b71488eca"> 41</a></span>&#160; <a class="code" href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">clock_type::time_point</a> <span class="keyword">const</span>&amp; <a class="code" href="classripple_1_1PeerFinder_1_1Fixed.html#a26ea4d7cb7efbbdd51dcf11b71488eca">when</a> ()<span class="keyword"> const</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classripple_1_1PeerFinder_1_1Fixed.html#a46faebd61d3d45de66bb08c1384142ab">m_when</a>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; }</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Fixed.html#ad2c4872213cb93da59d64f6374bdc66d"> 47</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classripple_1_1PeerFinder_1_1Fixed.html#ad2c4872213cb93da59d64f6374bdc66d">failure</a> (<a class="code" href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">clock_type::time_point</a> <span class="keyword">const</span>&amp; now)</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; {</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <a class="code" href="classripple_1_1PeerFinder_1_1Fixed.html#ae79d8f907dbc172093445f68b051de24">m_failures</a> = <a class="codeRef" href="http://en.cppreference.com/w/cpp/algorithm/min.html">std::min</a> (<a class="code" href="classripple_1_1PeerFinder_1_1Fixed.html#ae79d8f907dbc172093445f68b051de24">m_failures</a> + 1,</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <a class="code" href="namespaceripple_1_1PeerFinder_1_1Tuning.html#a4395e6f3599d47cada17f80fe10f479c">Tuning::connectionBackoff</a>.size() - 1);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <a class="code" href="classripple_1_1PeerFinder_1_1Fixed.html#a46faebd61d3d45de66bb08c1384142ab">m_when</a> = now + <a class="codeRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::minutes</a> (</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <a class="code" href="namespaceripple_1_1PeerFinder_1_1Tuning.html#a4395e6f3599d47cada17f80fe10f479c">Tuning::connectionBackoff</a> [<a class="code" href="classripple_1_1PeerFinder_1_1Fixed.html#ae79d8f907dbc172093445f68b051de24">m_failures</a>]);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; }</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Fixed.html#ad703ac09879fa69ca642ddaae44b3051"> 56</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classripple_1_1PeerFinder_1_1Fixed.html#ad703ac09879fa69ca642ddaae44b3051">success</a> (<a class="code" href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">clock_type::time_point</a> <span class="keyword">const</span>&amp; now)</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; {</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <a class="code" href="classripple_1_1PeerFinder_1_1Fixed.html#ae79d8f907dbc172093445f68b051de24">m_failures</a> = 0;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <a class="code" href="classripple_1_1PeerFinder_1_1Fixed.html#a46faebd61d3d45de66bb08c1384142ab">m_when</a> = now;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; }</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Fixed.html#a46faebd61d3d45de66bb08c1384142ab"> 63</a></span>&#160; <a class="code" href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">clock_type::time_point</a> <a class="code" href="classripple_1_1PeerFinder_1_1Fixed.html#a46faebd61d3d45de66bb08c1384142ab">m_when</a>;</div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classripple_1_1PeerFinder_1_1Fixed.html#ae79d8f907dbc172093445f68b051de24"> 64</a></span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> <a class="code" href="classripple_1_1PeerFinder_1_1Fixed.html#ae79d8f907dbc172093445f68b051de24">m_failures</a>;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;};</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;}</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;}</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<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="anamespaceripple_1_1PeerFinder_1_1Tuning_html_a4395e6f3599d47cada17f80fe10f479c"><div class="ttname"><a href="namespaceripple_1_1PeerFinder_1_1Tuning.html#a4395e6f3599d47cada17f80fe10f479c">ripple::PeerFinder::Tuning::connectionBackoff</a></div><div class="ttdeci">static const std::array&lt; int, 10 &gt; connectionBackoff</div><div class="ttdef"><b>Definition:</b> <a href="peerfinder_2impl_2Tuning_8h_source.html#l00076">peerfinder/impl/Tuning.h:76</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#l00032">Fixed.h:32</a></div></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="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#l00029">Fixed.h:29</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_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_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#l00064">Fixed.h:64</a></div></div>
<div class="ttc" id="aclassripple_1_1PeerFinder_1_1Fixed_html_a26ea4d7cb7efbbdd51dcf11b71488eca"><div class="ttname"><a href="classripple_1_1PeerFinder_1_1Fixed.html#a26ea4d7cb7efbbdd51dcf11b71488eca">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#l00041">Fixed.h:41</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#l00063">Fixed.h:63</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_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#l00047">Fixed.h:47</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#l00056">Fixed.h:56</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::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#l00063">abstract_clock.h:63</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>