ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-21 03:26:01 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
2ef1af9423e3adf2a90158ce99b5ef20fc13619e
rippled/LedgerCleaner_8h_source.html
ximinez e1dae4fb62 deploy: 3cbdf818a7
2025-09-18 10:58:55 -07:00

166 lines
18 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: LedgerCleaner.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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">LedgerCleaner.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 RIPPLE_APP_LEDGER_LEDGERCLEANER_H_INCLUDED</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define RIPPLE_APP_LEDGER_LEDGERCLEANER_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> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;xrpl/beast/utility/Journal.h&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include &lt;xrpl/beast/utility/PropertyStream.h&gt;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include &lt;xrpl/json/json_value.h&gt;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="foldopen" id="foldopen00032" data-start="{" data-end="};">
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="classripple_1_1LedgerCleaner.html"> 32</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1LedgerCleaner.html">LedgerCleaner</a> : <span class="keyword">public</span> <a class="code hl_class" href="classbeast_1_1PropertyStream_1_1Source.html">beast::PropertyStream::Source</a></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span>{</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">protected</span>:</div>
<div class="foldopen" id="foldopen00035" data-start="{" data-end="}">
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="classripple_1_1LedgerCleaner.html#a4d546a81c7c04bf522a7fc459af05d4f"> 35</a></span> <a class="code hl_function" href="classripple_1_1LedgerCleaner.html#a4d546a81c7c04bf522a7fc459af05d4f">LedgerCleaner</a>() : <a class="code hl_namespace" href="namespacebeast.html">beast</a>::PropertyStream::<a class="code hl_function" href="classbeast_1_1PropertyStream_1_1Source.html#a1dd058a9799aec943c4f52aa263f6242">Source</a>(<span class="stringliteral">&quot;ledgercleaner&quot;</span>)</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> {</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> }</div>
</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="classripple_1_1LedgerCleaner.html#a0521604687726272f4a27c5e20d60e8f"> 40</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classripple_1_1LedgerCleaner.html#a0521604687726272f4a27c5e20d60e8f">~LedgerCleaner</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="classripple_1_1LedgerCleaner.html#a424f7fb6ccbca294005df62e49352ef7"> 43</a></span> <a class="code hl_function" href="classripple_1_1LedgerCleaner.html#a424f7fb6ccbca294005df62e49352ef7">start</a>() = 0;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classripple_1_1LedgerCleaner.html#a99c5e871dc66065e140420eaa6a0898e"> 46</a></span> <a class="code hl_function" href="classripple_1_1LedgerCleaner.html#a99c5e871dc66065e140420eaa6a0898e">stop</a>() = 0;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="classripple_1_1LedgerCleaner.html#a066c0286840188ce6e10ce2a257eda9b"> 59</a></span> <a class="code hl_function" href="classripple_1_1LedgerCleaner.html#a066c0286840188ce6e10ce2a257eda9b">clean</a>(<a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a> <span class="keyword">const</span>&amp; parameters) = 0;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span>};</div>
</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr&lt;LedgerCleaner&gt;</a></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><a class="code hl_function" href="namespaceripple.html#a1fa80b10dd77df53d51444d2258940e5">make_LedgerCleaner</a>(<a class="code hl_class" href="classripple_1_1Application.html">Application</a>&amp; app, <a class="code hl_class" href="classbeast_1_1Journal.html">beast::Journal</a> journal);</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassJson_1_1Value_html"><div class="ttname"><a href="classJson_1_1Value.html">Json::Value</a></div><div class="ttdoc">Represents a JSON value.</div><div class="ttdef"><b>Definition</b> <a href="json__value_8h_source.html#l00148">json_value.h:149</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="aclassbeast_1_1PropertyStream_1_1Source_html"><div class="ttname"><a href="classbeast_1_1PropertyStream_1_1Source.html">beast::PropertyStream::Source</a></div><div class="ttdoc">Subclasses can be called to write to a stream and have children.</div><div class="ttdef"><b>Definition</b> <a href="PropertyStream_8h_source.html#l00328">PropertyStream.h:329</a></div></div>
<div class="ttc" id="aclassbeast_1_1PropertyStream_1_1Source_html_a1dd058a9799aec943c4f52aa263f6242"><div class="ttname"><a href="classbeast_1_1PropertyStream_1_1Source.html#a1dd058a9799aec943c4f52aa263f6242">beast::PropertyStream::Source::Source</a></div><div class="ttdeci">Source(std::string const &amp;name)</div><div class="ttdef"><b>Definition</b> <a href="beast__PropertyStream_8cpp_source.html#l00179">beast_PropertyStream.cpp:179</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_1LedgerCleaner_html"><div class="ttname"><a href="classripple_1_1LedgerCleaner.html">ripple::LedgerCleaner</a></div><div class="ttdoc">Check the ledger/transaction databases to make sure they have continuity.</div><div class="ttdef"><b>Definition</b> <a href="LedgerCleaner_8h_source.html#l00032">LedgerCleaner.h:33</a></div></div>
<div class="ttc" id="aclassripple_1_1LedgerCleaner_html_a0521604687726272f4a27c5e20d60e8f"><div class="ttname"><a href="classripple_1_1LedgerCleaner.html#a0521604687726272f4a27c5e20d60e8f">ripple::LedgerCleaner::~LedgerCleaner</a></div><div class="ttdeci">virtual ~LedgerCleaner()=default</div></div>
<div class="ttc" id="aclassripple_1_1LedgerCleaner_html_a066c0286840188ce6e10ce2a257eda9b"><div class="ttname"><a href="classripple_1_1LedgerCleaner.html#a066c0286840188ce6e10ce2a257eda9b">ripple::LedgerCleaner::clean</a></div><div class="ttdeci">virtual void clean(Json::Value const &amp;parameters)=0</div><div class="ttdoc">Start a long running task to clean the ledger.</div></div>
<div class="ttc" id="aclassripple_1_1LedgerCleaner_html_a424f7fb6ccbca294005df62e49352ef7"><div class="ttname"><a href="classripple_1_1LedgerCleaner.html#a424f7fb6ccbca294005df62e49352ef7">ripple::LedgerCleaner::start</a></div><div class="ttdeci">virtual void start()=0</div></div>
<div class="ttc" id="aclassripple_1_1LedgerCleaner_html_a4d546a81c7c04bf522a7fc459af05d4f"><div class="ttname"><a href="classripple_1_1LedgerCleaner.html#a4d546a81c7c04bf522a7fc459af05d4f">ripple::LedgerCleaner::LedgerCleaner</a></div><div class="ttdeci">LedgerCleaner()</div><div class="ttdef"><b>Definition</b> <a href="LedgerCleaner_8h_source.html#l00035">LedgerCleaner.h:35</a></div></div>
<div class="ttc" id="aclassripple_1_1LedgerCleaner_html_a99c5e871dc66065e140420eaa6a0898e"><div class="ttname"><a href="classripple_1_1LedgerCleaner.html#a99c5e871dc66065e140420eaa6a0898e">ripple::LedgerCleaner::stop</a></div><div class="ttdeci">virtual void stop()=0</div></div>
<div class="ttc" id="anamespacebeast_html"><div class="ttname"><a href="namespacebeast.html">beast</a></div><div class="ttdef"><b>Definition</b> <a href="base__uint_8h_source.html#l00672">base_uint.h:672</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_a1fa80b10dd77df53d51444d2258940e5"><div class="ttname"><a href="namespaceripple.html#a1fa80b10dd77df53d51444d2258940e5">ripple::make_LedgerCleaner</a></div><div class="ttdeci">std::unique_ptr&lt; LedgerCleaner &gt; make_LedgerCleaner(Application &amp;app, beast::Journal journal)</div><div class="ttdef"><b>Definition</b> <a href="LedgerCleaner_8cpp_source.html#l00460">LedgerCleaner.cpp:460</a></div></div>
<div class="ttc" id="aunique_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_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