ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-22 03:55:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
691c2d46b0ab669776c13903f68a8ae9f1dbd7a8
rippled/TimeoutCounter_8h_source.html
bthomee 691c2d46b0 deploy: ada83564d8
2025-11-03 23:17:02 -08:00

234 lines
36 KiB
HTML
Raw Blame History

<!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: TimeoutCounter.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_c69db3203fa08a9ff994909ba6ee9783.html">app</a></li><li class="navelem"><a class="el" href="dir_7899ad0c658a3b97a951171682eee0fc.html">ledger</a></li><li class="navelem"><a class="el" href="dir_33905d6b0bac037e3317dfcb3fc24fbf.html">detail</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">TimeoutCounter.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="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">/*</span></div>
<div class="line"><a id="l00003" 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 id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"></span> </div>
<div class="line"><a id="l00006" 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 id="l00007" 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 id="l00008" 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 id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a id="l00011" 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 id="l00012" 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 id="l00013" 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 id="l00014" 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 id="l00015" 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 id="l00016" 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 id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">*/</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">//==============================================================================</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifndef XRPL_APP_LEDGER_TIMEOUTCOUNTER_H_INCLUDED</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define XRPL_APP_LEDGER_TIMEOUTCOUNTER_H_INCLUDED</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &lt;xrpld/app/main/Application.h&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &lt;xrpld/core/Job.h&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include &lt;xrpl/beast/utility/Journal.h&gt;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include &lt;boost/asio/basic_waitable_timer.hpp&gt;</span></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><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 id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="foldopen" id="foldopen00068" data-start="{" data-end="};">
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="classripple_1_1TimeoutCounter.html"> 68</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1TimeoutCounter.html">TimeoutCounter</a></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span>{</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <a class="code hl_function" href="classripple_1_1TimeoutCounter.html#ac9f8538b7f73ebcda116c33d5541d16d">cancel</a>();</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="classripple_1_1TimeoutCounter.html#acc58d4a18742a417a8b290df4b58072d"> 83</a></span> <span class="keyword">using </span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/thread/unique_lock.html">ScopedLockType</a> = <a class="code hl_classRef" 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 id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="foldopen" id="foldopen00085" data-start="{" data-end="};">
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="structripple_1_1TimeoutCounter_1_1QueueJobParameter.html"> 85</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structripple_1_1TimeoutCounter_1_1QueueJobParameter.html">QueueJobParameter</a></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> {</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="structripple_1_1TimeoutCounter_1_1QueueJobParameter.html#add1939c6511d09e7cf1ef25403221f12"> 87</a></span> <a class="code hl_enumeration" href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">JobType</a> <a class="code hl_variable" href="structripple_1_1TimeoutCounter_1_1QueueJobParameter.html#add1939c6511d09e7cf1ef25403221f12">jobType</a>;</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="structripple_1_1TimeoutCounter_1_1QueueJobParameter.html#a24794ac69a9ce6e5e13ab99e3a12c7d4"> 88</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <a class="code hl_variable" href="structripple_1_1TimeoutCounter_1_1QueueJobParameter.html#a24794ac69a9ce6e5e13ab99e3a12c7d4">jobName</a>;</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="structripple_1_1TimeoutCounter_1_1QueueJobParameter.html#a69017875ec0c981bfb3d322329e625be"> 89</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;std::uint32_t&gt;</a> <a class="code hl_variable" href="structripple_1_1TimeoutCounter_1_1QueueJobParameter.html#a69017875ec0c981bfb3d322329e625be">jobLimit</a>;</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> };</div>
</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <a class="code hl_class" href="classripple_1_1TimeoutCounter.html">TimeoutCounter</a>(</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <a class="code hl_class" href="classripple_1_1Application.html">Application</a>&amp; app,</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp; targetHash,</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::milliseconds</a> timeoutInterval,</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <a class="code hl_struct" href="structripple_1_1TimeoutCounter_1_1QueueJobParameter.html">QueueJobParameter</a>&amp;&amp; jobParameter,</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <a class="code hl_class" href="classbeast_1_1Journal.html">beast::Journal</a> journal);</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"><a class="line" href="classripple_1_1TimeoutCounter.html#a5237b8bd5776dd16d54d214c08e16328"> 99</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classripple_1_1TimeoutCounter.html#a5237b8bd5776dd16d54d214c08e16328">~TimeoutCounter</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <a class="code hl_function" href="classripple_1_1TimeoutCounter.html#a3a01b0664f4479588f93e805ee9aaced">setTimer</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/thread/unique_lock.html">ScopedLockType</a>&amp;);</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <a class="code hl_function" href="classripple_1_1TimeoutCounter.html#a0679c129f5ffcdcf46b6b2ce6f31a553">queueJob</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/thread/unique_lock.html">ScopedLockType</a>&amp;);</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"><a class="line" href="classripple_1_1TimeoutCounter.html#a17c93d4a677d83e11650fbf5812379c8"> 111</a></span> <a class="code hl_function" href="classripple_1_1TimeoutCounter.html#a17c93d4a677d83e11650fbf5812379c8">onTimer</a>(<span class="keywordtype">bool</span> progress, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/thread/unique_lock.html">ScopedLockType</a>&amp;) = 0;</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> </div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <span class="keyword">virtual</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/weak_ptr.html">std::weak_ptr&lt;TimeoutCounter&gt;</a></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"><a class="line" href="classripple_1_1TimeoutCounter.html#aa5aeaf14b76435677f3f7481f5dae899"> 115</a></span> <a class="code hl_function" href="classripple_1_1TimeoutCounter.html#aa5aeaf14b76435677f3f7481f5dae899">pmDowncast</a>() = 0;</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> <span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00118" data-start="{" data-end="}">
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"><a class="line" href="classripple_1_1TimeoutCounter.html#a28e1660d3e1964810a10e298cd2f5c94"> 118</a></span> <a class="code hl_function" href="classripple_1_1TimeoutCounter.html#a28e1660d3e1964810a10e298cd2f5c94">isDone</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classripple_1_1TimeoutCounter.html#a7136bc55557a72b6fe16984b9afd0ace">complete_</a> || <a class="code hl_variable" href="classripple_1_1TimeoutCounter.html#ae8d27d1e5f6f3d5a6cb59545b2ee7433">failed_</a>;</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> }</div>
</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> </div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> <span class="comment">// Used in this class for access to boost::asio::io_context and</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> <span class="comment">// ripple::Overlay. Used in subtypes for the kitchen sink.</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"><a class="line" href="classripple_1_1TimeoutCounter.html#ad9edbc193ee8a2d70897613e9debfdb7"> 125</a></span> <a class="code hl_class" href="classripple_1_1Application.html">Application</a>&amp; <a class="code hl_variable" href="classripple_1_1TimeoutCounter.html#ad9edbc193ee8a2d70897613e9debfdb7">app_</a>;</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"><a class="line" href="classripple_1_1TimeoutCounter.html#a85b050512eadcc42934c1a03cba6ce79"> 126</a></span> <a class="code hl_class" href="classbeast_1_1Journal.html">beast::Journal</a> <a class="code hl_variable" href="classripple_1_1TimeoutCounter.html#a85b050512eadcc42934c1a03cba6ce79">journal_</a>;</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"><a class="line" href="classripple_1_1TimeoutCounter.html#ad13bccc1f788cec83fd1d81cb2e80743"> 127</a></span> <span class="keyword">mutable</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html">std::recursive_mutex</a> <a class="code hl_variable" href="classripple_1_1TimeoutCounter.html#ad13bccc1f788cec83fd1d81cb2e80743">mtx_</a>;</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> </div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"><a class="line" href="classripple_1_1TimeoutCounter.html#a8f0d7c15dfbdda95cc8b01a1a5b9e722"> 131</a></span> <a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span> <a class="code hl_variable" href="classripple_1_1TimeoutCounter.html#a8f0d7c15dfbdda95cc8b01a1a5b9e722">hash_</a>;</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"><a class="line" href="classripple_1_1TimeoutCounter.html#ab6b3661800dfea540e8c6d4121b502bc"> 132</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="classripple_1_1TimeoutCounter.html#ab6b3661800dfea540e8c6d4121b502bc">timeouts_</a>;</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"><a class="line" href="classripple_1_1TimeoutCounter.html#a7136bc55557a72b6fe16984b9afd0ace"> 133</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classripple_1_1TimeoutCounter.html#a7136bc55557a72b6fe16984b9afd0ace">complete_</a>;</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"><a class="line" href="classripple_1_1TimeoutCounter.html#ae8d27d1e5f6f3d5a6cb59545b2ee7433"> 134</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classripple_1_1TimeoutCounter.html#ae8d27d1e5f6f3d5a6cb59545b2ee7433">failed_</a>;</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"><a class="line" href="classripple_1_1TimeoutCounter.html#a2e38caa16d926bbc77c92f67a69facfb"> 136</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classripple_1_1TimeoutCounter.html#a2e38caa16d926bbc77c92f67a69facfb">progress_</a>;</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"><a class="line" href="classripple_1_1TimeoutCounter.html#a4cd3ab8d59bc971262ec26d715f8538a"> 138</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::milliseconds</a> <a class="code hl_variable" href="classripple_1_1TimeoutCounter.html#a4cd3ab8d59bc971262ec26d715f8538a">timerInterval_</a>;</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> </div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"><a class="line" href="classripple_1_1TimeoutCounter.html#a57a50217ec6ad8fb6ff2af4496fe5ea8"> 140</a></span> <a class="code hl_struct" href="structripple_1_1TimeoutCounter_1_1QueueJobParameter.html">QueueJobParameter</a> <a class="code hl_variable" href="classripple_1_1TimeoutCounter.html#a57a50217ec6ad8fb6ff2af4496fe5ea8">queueJobParameter_</a>;</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> </div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> <a class="code hl_function" href="classripple_1_1TimeoutCounter.html#a3e417a539a334133b056df64d06ddda0">invokeOnTimer</a>();</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> </div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"><a class="line" href="classripple_1_1TimeoutCounter.html#a9c57abb1684ecfa13a3c567b0406d416"> 149</a></span> boost::asio::basic_waitable_timer&lt;std::chrono::steady_clock&gt; <a class="code hl_variable" href="classripple_1_1TimeoutCounter.html#a9c57abb1684ecfa13a3c567b0406d416">timer_</a>;</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span>};</div>
</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> </div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> </div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="abasic_string_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</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#l00059">Journal.h:60</a></div></div>
<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#l00113">Application.h:114</a></div></div>
<div class="ttc" id="aclassripple_1_1TimeoutCounter_html"><div class="ttname"><a href="classripple_1_1TimeoutCounter.html">ripple::TimeoutCounter</a></div><div class="ttdoc">This class is an &quot;active&quot; object.</div><div class="ttdef"><b>Definition</b> <a href="TimeoutCounter_8h_source.html#l00068">TimeoutCounter.h:69</a></div></div>
<div class="ttc" id="aclassripple_1_1TimeoutCounter_html_a0679c129f5ffcdcf46b6b2ce6f31a553"><div class="ttname"><a href="classripple_1_1TimeoutCounter.html#a0679c129f5ffcdcf46b6b2ce6f31a553">ripple::TimeoutCounter::queueJob</a></div><div class="ttdeci">void queueJob(ScopedLockType &amp;)</div><div class="ttdoc">Queue a job to call invokeOnTimer().</div><div class="ttdef"><b>Definition</b> <a href="TimeoutCounter_8cpp_source.html#l00069">TimeoutCounter.cpp:69</a></div></div>
<div class="ttc" id="aclassripple_1_1TimeoutCounter_html_a17c93d4a677d83e11650fbf5812379c8"><div class="ttname"><a href="classripple_1_1TimeoutCounter.html#a17c93d4a677d83e11650fbf5812379c8">ripple::TimeoutCounter::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_1TimeoutCounter_html_a28e1660d3e1964810a10e298cd2f5c94"><div class="ttname"><a href="classripple_1_1TimeoutCounter.html#a28e1660d3e1964810a10e298cd2f5c94">ripple::TimeoutCounter::isDone</a></div><div class="ttdeci">bool isDone() const</div><div class="ttdef"><b>Definition</b> <a href="TimeoutCounter_8h_source.html#l00118">TimeoutCounter.h:118</a></div></div>
<div class="ttc" id="aclassripple_1_1TimeoutCounter_html_a2e38caa16d926bbc77c92f67a69facfb"><div class="ttname"><a href="classripple_1_1TimeoutCounter.html#a2e38caa16d926bbc77c92f67a69facfb">ripple::TimeoutCounter::progress_</a></div><div class="ttdeci">bool progress_</div><div class="ttdoc">Whether forward progress has been made.</div><div class="ttdef"><b>Definition</b> <a href="TimeoutCounter_8h_source.html#l00136">TimeoutCounter.h:136</a></div></div>
<div class="ttc" id="aclassripple_1_1TimeoutCounter_html_a3a01b0664f4479588f93e805ee9aaced"><div class="ttname"><a href="classripple_1_1TimeoutCounter.html#a3a01b0664f4479588f93e805ee9aaced">ripple::TimeoutCounter::setTimer</a></div><div class="ttdeci">void setTimer(ScopedLockType &amp;)</div><div class="ttdoc">Schedule a call to queueJob() after mTimerInterval.</div><div class="ttdef"><b>Definition</b> <a href="TimeoutCounter_8cpp_source.html#l00050">TimeoutCounter.cpp:50</a></div></div>
<div class="ttc" id="aclassripple_1_1TimeoutCounter_html_a3e417a539a334133b056df64d06ddda0"><div class="ttname"><a href="classripple_1_1TimeoutCounter.html#a3e417a539a334133b056df64d06ddda0">ripple::TimeoutCounter::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="TimeoutCounter_8cpp_source.html#l00093">TimeoutCounter.cpp:93</a></div></div>
<div class="ttc" id="aclassripple_1_1TimeoutCounter_html_a4cd3ab8d59bc971262ec26d715f8538a"><div class="ttname"><a href="classripple_1_1TimeoutCounter.html#a4cd3ab8d59bc971262ec26d715f8538a">ripple::TimeoutCounter::timerInterval_</a></div><div class="ttdeci">std::chrono::milliseconds timerInterval_</div><div class="ttdoc">The minimum time to wait between calls to execute().</div><div class="ttdef"><b>Definition</b> <a href="TimeoutCounter_8h_source.html#l00138">TimeoutCounter.h:138</a></div></div>
<div class="ttc" id="aclassripple_1_1TimeoutCounter_html_a5237b8bd5776dd16d54d214c08e16328"><div class="ttname"><a href="classripple_1_1TimeoutCounter.html#a5237b8bd5776dd16d54d214c08e16328">ripple::TimeoutCounter::~TimeoutCounter</a></div><div class="ttdeci">virtual ~TimeoutCounter()=default</div></div>
<div class="ttc" id="aclassripple_1_1TimeoutCounter_html_a57a50217ec6ad8fb6ff2af4496fe5ea8"><div class="ttname"><a href="classripple_1_1TimeoutCounter.html#a57a50217ec6ad8fb6ff2af4496fe5ea8">ripple::TimeoutCounter::queueJobParameter_</a></div><div class="ttdeci">QueueJobParameter queueJobParameter_</div><div class="ttdef"><b>Definition</b> <a href="TimeoutCounter_8h_source.html#l00140">TimeoutCounter.h:140</a></div></div>
<div class="ttc" id="aclassripple_1_1TimeoutCounter_html_a7136bc55557a72b6fe16984b9afd0ace"><div class="ttname"><a href="classripple_1_1TimeoutCounter.html#a7136bc55557a72b6fe16984b9afd0ace">ripple::TimeoutCounter::complete_</a></div><div class="ttdeci">bool complete_</div><div class="ttdef"><b>Definition</b> <a href="TimeoutCounter_8h_source.html#l00133">TimeoutCounter.h:133</a></div></div>
<div class="ttc" id="aclassripple_1_1TimeoutCounter_html_a85b050512eadcc42934c1a03cba6ce79"><div class="ttname"><a href="classripple_1_1TimeoutCounter.html#a85b050512eadcc42934c1a03cba6ce79">ripple::TimeoutCounter::journal_</a></div><div class="ttdeci">beast::Journal journal_</div><div class="ttdef"><b>Definition</b> <a href="TimeoutCounter_8h_source.html#l00126">TimeoutCounter.h:126</a></div></div>
<div class="ttc" id="aclassripple_1_1TimeoutCounter_html_a8f0d7c15dfbdda95cc8b01a1a5b9e722"><div class="ttname"><a href="classripple_1_1TimeoutCounter.html#a8f0d7c15dfbdda95cc8b01a1a5b9e722">ripple::TimeoutCounter::hash_</a></div><div class="ttdeci">uint256 const hash_</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="TimeoutCounter_8h_source.html#l00131">TimeoutCounter.h:131</a></div></div>
<div class="ttc" id="aclassripple_1_1TimeoutCounter_html_a9c57abb1684ecfa13a3c567b0406d416"><div class="ttname"><a href="classripple_1_1TimeoutCounter.html#a9c57abb1684ecfa13a3c567b0406d416">ripple::TimeoutCounter::timer_</a></div><div class="ttdeci">boost::asio::basic_waitable_timer&lt; std::chrono::steady_clock &gt; timer_</div><div class="ttdef"><b>Definition</b> <a href="TimeoutCounter_8h_source.html#l00149">TimeoutCounter.h:149</a></div></div>
<div class="ttc" id="aclassripple_1_1TimeoutCounter_html_aa5aeaf14b76435677f3f7481f5dae899"><div class="ttname"><a href="classripple_1_1TimeoutCounter.html#aa5aeaf14b76435677f3f7481f5dae899">ripple::TimeoutCounter::pmDowncast</a></div><div class="ttdeci">virtual std::weak_ptr&lt; TimeoutCounter &gt; pmDowncast()=0</div><div class="ttdoc">Return a weak pointer to this.</div></div>
<div class="ttc" id="aclassripple_1_1TimeoutCounter_html_ab6b3661800dfea540e8c6d4121b502bc"><div class="ttname"><a href="classripple_1_1TimeoutCounter.html#ab6b3661800dfea540e8c6d4121b502bc">ripple::TimeoutCounter::timeouts_</a></div><div class="ttdeci">int timeouts_</div><div class="ttdef"><b>Definition</b> <a href="TimeoutCounter_8h_source.html#l00132">TimeoutCounter.h:132</a></div></div>
<div class="ttc" id="aclassripple_1_1TimeoutCounter_html_ac9f8538b7f73ebcda116c33d5541d16d"><div class="ttname"><a href="classripple_1_1TimeoutCounter.html#ac9f8538b7f73ebcda116c33d5541d16d">ripple::TimeoutCounter::cancel</a></div><div class="ttdeci">virtual void cancel()</div><div class="ttdoc">Cancel the task by marking it as failed if the task is not done.</div><div class="ttdef"><b>Definition</b> <a href="TimeoutCounter_8cpp_source.html#l00118">TimeoutCounter.cpp:118</a></div></div>
<div class="ttc" id="aclassripple_1_1TimeoutCounter_html_ad13bccc1f788cec83fd1d81cb2e80743"><div class="ttname"><a href="classripple_1_1TimeoutCounter.html#ad13bccc1f788cec83fd1d81cb2e80743">ripple::TimeoutCounter::mtx_</a></div><div class="ttdeci">std::recursive_mutex mtx_</div><div class="ttdef"><b>Definition</b> <a href="TimeoutCounter_8h_source.html#l00127">TimeoutCounter.h:127</a></div></div>
<div class="ttc" id="aclassripple_1_1TimeoutCounter_html_ad9edbc193ee8a2d70897613e9debfdb7"><div class="ttname"><a href="classripple_1_1TimeoutCounter.html#ad9edbc193ee8a2d70897613e9debfdb7">ripple::TimeoutCounter::app_</a></div><div class="ttdeci">Application &amp; app_</div><div class="ttdef"><b>Definition</b> <a href="TimeoutCounter_8h_source.html#l00125">TimeoutCounter.h:125</a></div></div>
<div class="ttc" id="aclassripple_1_1TimeoutCounter_html_ae8d27d1e5f6f3d5a6cb59545b2ee7433"><div class="ttname"><a href="classripple_1_1TimeoutCounter.html#ae8d27d1e5f6f3d5a6cb59545b2ee7433">ripple::TimeoutCounter::failed_</a></div><div class="ttdeci">bool failed_</div><div class="ttdef"><b>Definition</b> <a href="TimeoutCounter_8h_source.html#l00134">TimeoutCounter.h:134</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="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="amutex_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/mutex.html">mutex</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#l00025">algorithm.h:25</a></div></div>
<div class="ttc" id="anamespaceripple_html_ae0f54f8ce649d639bf3e2b295347e17a"><div class="ttname"><a href="namespaceripple.html#ae0f54f8ce649d639bf3e2b295347e17a">ripple::JobType</a></div><div class="ttdeci">JobType</div><div class="ttdef"><b>Definition</b> <a href="Job_8h_source.html#l00035">Job.h:35</a></div></div>
<div class="ttc" id="aoptional_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</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>
<div class="ttc" id="astructripple_1_1TimeoutCounter_1_1QueueJobParameter_html"><div class="ttname"><a href="structripple_1_1TimeoutCounter_1_1QueueJobParameter.html">ripple::TimeoutCounter::QueueJobParameter</a></div><div class="ttdef"><b>Definition</b> <a href="TimeoutCounter_8h_source.html#l00085">TimeoutCounter.h:86</a></div></div>
<div class="ttc" id="astructripple_1_1TimeoutCounter_1_1QueueJobParameter_html_a24794ac69a9ce6e5e13ab99e3a12c7d4"><div class="ttname"><a href="structripple_1_1TimeoutCounter_1_1QueueJobParameter.html#a24794ac69a9ce6e5e13ab99e3a12c7d4">ripple::TimeoutCounter::QueueJobParameter::jobName</a></div><div class="ttdeci">std::string jobName</div><div class="ttdef"><b>Definition</b> <a href="TimeoutCounter_8h_source.html#l00088">TimeoutCounter.h:88</a></div></div>
<div class="ttc" id="astructripple_1_1TimeoutCounter_1_1QueueJobParameter_html_a69017875ec0c981bfb3d322329e625be"><div class="ttname"><a href="structripple_1_1TimeoutCounter_1_1QueueJobParameter.html#a69017875ec0c981bfb3d322329e625be">ripple::TimeoutCounter::QueueJobParameter::jobLimit</a></div><div class="ttdeci">std::optional&lt; std::uint32_t &gt; jobLimit</div><div class="ttdef"><b>Definition</b> <a href="TimeoutCounter_8h_source.html#l00089">TimeoutCounter.h:89</a></div></div>
<div class="ttc" id="astructripple_1_1TimeoutCounter_1_1QueueJobParameter_html_add1939c6511d09e7cf1ef25403221f12"><div class="ttname"><a href="structripple_1_1TimeoutCounter_1_1QueueJobParameter.html#add1939c6511d09e7cf1ef25403221f12">ripple::TimeoutCounter::QueueJobParameter::jobType</a></div><div class="ttdeci">JobType jobType</div><div class="ttdef"><b>Definition</b> <a href="TimeoutCounter_8h_source.html#l00087">TimeoutCounter.h:87</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="aweak_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/weak_ptr.html">std::weak_ptr</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>
Reference in New Issue View Git Blame Copy Permalink