mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-22 03:55:53 +00:00
163 lines
19 KiB
HTML
163 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">
|
|
<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: ShardVerificationScheduler.cpp 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&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&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_f4afb74df24474efa0cc7e8ea3ddd5ce.html">rpc</a></li><li class="navelem"><a class="el" href="dir_c0859c9018fba023f632e238d012381a.html">impl</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">ShardVerificationScheduler.cpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <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> <span class="comment"> Copyright (c) 2020 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <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> <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> <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> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <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> <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> <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> <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> <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> <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> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <ripple/app/ledger/LedgerMaster.h></span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <ripple/rpc/ShardVerificationScheduler.h></span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">namespace </span>RPC {</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#adca60c2989aeba9a5d0bf77cfe55dad8"> 26</a></span> <a class="code" href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#ae0519c75d794573af6f6e54674d94f04">ShardVerificationScheduler::ShardVerificationScheduler</a>(</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a> retryInterval,</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> maxAttempts)</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  : retryInterval_(</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  (retryInterval == <a class="code" href="namespacestd.html">std</a>::chrono::seconds(0) ? defaultRetryInterval_</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  : retryInterval))</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  , maxAttempts_(maxAttempts == 0 ? defaultmaxAttempts_ : maxAttempts)</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> }</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keywordtype">bool</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#a399ba57d69fdfad772409c72361363fd"> 37</a></span> <a class="code" href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#a399ba57d69fdfad772409c72361363fd">ShardVerificationScheduler::retry</a>(</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="classripple_1_1Application.html">Application</a>& app,</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">bool</span> shouldHaveHash,</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">retryFunction</a> f)</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> {</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordflow">if</span> (<a class="code" href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#afc775e38954e00b76a1e268740b5fa1e">numAttempts_</a> >= <a class="code" href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#a0bc1ba9bf597f9af68cd09d41c225b7f">maxAttempts_</a>)</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">// Retry attempts only count when we</span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="comment">// have a validated ledger with a</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">// sequence later than the shard's</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// last ledger.</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordflow">if</span> (shouldHaveHash)</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  ++<a class="code" href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#afc775e38954e00b76a1e268740b5fa1e">numAttempts_</a>;</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordflow">if</span> (!<a class="code" href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#a40022095eeb4708e02bf736a0a9e5cc0">timer_</a>)</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#a40022095eeb4708e02bf736a0a9e5cc0">timer_</a> = std::make_unique<waitable_timer>(app.<a class="code" href="classripple_1_1Application.html#aeb96811d5ac7f90cf0736a5874aa55e9">getIOService</a>());</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#a40022095eeb4708e02bf736a0a9e5cc0">timer_</a>->expires_from_now(<a class="code" href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#abc235876e27eccc6c63584d232390f14">retryInterval_</a>);</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#a40022095eeb4708e02bf736a0a9e5cc0">timer_</a>->async_wait(f);</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> }</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#a33b34d5ee1010717b41810e3413323f1"> 62</a></span> <a class="code" href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#a33b34d5ee1010717b41810e3413323f1">ShardVerificationScheduler::reset</a>()</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> {</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#afc775e38954e00b76a1e268740b5fa1e">numAttempts_</a> = 0;</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> }</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> } <span class="comment">// namespace RPC</span></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> } <span class="comment">// namespace ripple</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#l00115">Application.h:115</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1RPC_1_1ShardVerificationScheduler_html_ae0519c75d794573af6f6e54674d94f04"><div class="ttname"><a href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#ae0519c75d794573af6f6e54674d94f04">ripple::RPC::ShardVerificationScheduler::ShardVerificationScheduler</a></div><div class="ttdeci">ShardVerificationScheduler()=default</div></div>
|
|
<div class="ttc" id="aclassripple_1_1RPC_1_1ShardVerificationScheduler_html_a33b34d5ee1010717b41810e3413323f1"><div class="ttname"><a href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#a33b34d5ee1010717b41810e3413323f1">ripple::RPC::ShardVerificationScheduler::reset</a></div><div class="ttdeci">void reset()</div><div class="ttdef"><b>Definition:</b> <a href="ShardVerificationScheduler_8cpp_source.html#l00062">ShardVerificationScheduler.cpp:62</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::seconds</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1RPC_1_1ShardVerificationScheduler_html_a40022095eeb4708e02bf736a0a9e5cc0"><div class="ttname"><a href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#a40022095eeb4708e02bf736a0a9e5cc0">ripple::RPC::ShardVerificationScheduler::timer_</a></div><div class="ttdeci">std::unique_ptr< waitable_timer > timer_</div><div class="ttdef"><b>Definition:</b> <a href="ShardVerificationScheduler_8h_source.html#l00075">ShardVerificationScheduler.h:75</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_1RPC_1_1ShardVerificationScheduler_html_a0bc1ba9bf597f9af68cd09d41c225b7f"><div class="ttname"><a href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#a0bc1ba9bf597f9af68cd09d41c225b7f">ripple::RPC::ShardVerificationScheduler::maxAttempts_</a></div><div class="ttdeci">const std::uint32_t maxAttempts_</div><div class="ttdef"><b>Definition:</b> <a href="ShardVerificationScheduler_8h_source.html#l00073">ShardVerificationScheduler.h:73</a></div></div>
|
|
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1RPC_1_1ShardVerificationScheduler_html_a399ba57d69fdfad772409c72361363fd"><div class="ttname"><a href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#a399ba57d69fdfad772409c72361363fd">ripple::RPC::ShardVerificationScheduler::retry</a></div><div class="ttdeci">bool retry(Application &app, bool shouldHaveHash, retryFunction f)</div><div class="ttdef"><b>Definition:</b> <a href="ShardVerificationScheduler_8cpp_source.html#l00037">ShardVerificationScheduler.cpp:37</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1RPC_1_1ShardVerificationScheduler_html_abc235876e27eccc6c63584d232390f14"><div class="ttname"><a href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#abc235876e27eccc6c63584d232390f14">ripple::RPC::ShardVerificationScheduler::retryInterval_</a></div><div class="ttdeci">const std::chrono::seconds retryInterval_</div><div class="ttdef"><b>Definition:</b> <a href="ShardVerificationScheduler_8h_source.html#l00070">ShardVerificationScheduler.h:70</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Application_html_aeb96811d5ac7f90cf0736a5874aa55e9"><div class="ttname"><a href="classripple_1_1Application.html#aeb96811d5ac7f90cf0736a5874aa55e9">ripple::Application::getIOService</a></div><div class="ttdeci">virtual boost::asio::io_service & getIOService()=0</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="anamespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdoc">STL namespace.</div></div>
|
|
<div class="ttc" id="aclassripple_1_1RPC_1_1ShardVerificationScheduler_html_afc775e38954e00b76a1e268740b5fa1e"><div class="ttname"><a href="classripple_1_1RPC_1_1ShardVerificationScheduler.html#afc775e38954e00b76a1e268740b5fa1e">ripple::RPC::ShardVerificationScheduler::numAttempts_</a></div><div class="ttdeci">std::uint32_t numAttempts_</div><div class="ttdef"><b>Definition:</b> <a href="ShardVerificationScheduler_8h_source.html#l00078">ShardVerificationScheduler.h:78</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|