ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-06 17:27:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e5d00ab2bf5a6fed840f2f17ebf7ba99974fe875
rippled/classripple_1_1RCLValidationsAdaptor.html
bthomee e61ca37029 deploy: eac3abdca9
2025-01-21 19:58:08 +00:00

344 lines
20 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.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::RCLValidationsAdaptor Class Reference</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.5 -->
<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>
<!-- 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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1RCLValidationsAdaptor.html">RCLValidationsAdaptor</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1RCLValidationsAdaptor-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::RCLValidationsAdaptor Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Generic validations adaptor class for RCL.
<a href="classripple_1_1RCLValidationsAdaptor.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="RCLValidations_8h_source.html">RCLValidations.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::RCLValidationsAdaptor:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1RCLValidationsAdaptor__coll__graph.png" border="0" usemap="#aripple_1_1RCLValidationsAdaptor_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1RCLValidationsAdaptor_coll__map" id="aripple_1_1RCLValidationsAdaptor_coll__map">
<area shape="rect" title="Generic validations adaptor class for RCL." alt="" coords="1396,163,1611,188"/>
<area shape="rect" href="classripple_1_1Application.html" title=" " alt="" coords="1158,137,1298,163"/>
<area shape="rect" href="classbeast_1_1PropertyStream_1_1Source.html" title="Subclasses can be called to write to a stream and have children." alt="" coords="860,94,1028,134"/>
<area shape="rect" href="classbeast_1_1PropertyStream_1_1Item.html" title=" " alt="" coords="1144,41,1312,81"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="612,52,699,77"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="297,45,435,85"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html" title=" " alt="" coords="576,101,735,127"/>
<area shape="rect" title=" " alt="" coords="871,5,1017,31"/>
<area shape="rect" href="classbeast_1_1List.html" title=" " alt="" coords="563,151,748,191"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="322,133,410,159"/>
<area shape="rect" href="classbeast_1_1detail_1_1ListNode.html" title=" " alt="" coords="275,183,457,237"/>
<area shape="rect" href="classbeast_1_1detail_1_1ListNode.html" title=" " alt="" coords="5,190,173,230"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="1173,187,1283,212"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="871,187,1017,212"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a62a437d55991171e4f85b05163bb1598"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLValidationsAdaptor.html#a62a437d55991171e4f85b05163bb1598">Mutex</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/thread/mutex.html">std::mutex</a></td></tr>
<tr class="separator:a62a437d55991171e4f85b05163bb1598"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a717fb5de9c44c66e0091074e14420c39"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLValidationsAdaptor.html#a717fb5de9c44c66e0091074e14420c39">Validation</a> = <a class="el" href="classripple_1_1RCLValidation.html">RCLValidation</a></td></tr>
<tr class="separator:a717fb5de9c44c66e0091074e14420c39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24754bc4b2f8983fe37263ee543f66b0"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLValidationsAdaptor.html#a24754bc4b2f8983fe37263ee543f66b0">Ledger</a> = <a class="el" href="classripple_1_1RCLValidatedLedger.html">RCLValidatedLedger</a></td></tr>
<tr class="separator:a24754bc4b2f8983fe37263ee543f66b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a642615a5ff0015b5cd42b215018f316f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLValidationsAdaptor.html#a642615a5ff0015b5cd42b215018f316f">RCLValidationsAdaptor</a> (<a class="el" href="classripple_1_1Application.html">Application</a> &amp;app, <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> j)</td></tr>
<tr class="separator:a642615a5ff0015b5cd42b215018f316f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71524d4aa1389ba9021de51a375b5e82"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1NetClock.html#a4c2428e178dca6689fa3fb4be0657107">NetClock::time_point</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLValidationsAdaptor.html#a71524d4aa1389ba9021de51a375b5e82">now</a> () const</td></tr>
<tr class="memdesc:a71524d4aa1389ba9021de51a375b5e82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current time used to determine if validations are stale. <a href="classripple_1_1RCLValidationsAdaptor.html#a71524d4aa1389ba9021de51a375b5e82">More...</a><br /></td></tr>
<tr class="separator:a71524d4aa1389ba9021de51a375b5e82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1165a5474d2df3d127171a8ff7af3659"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; <a class="el" href="classripple_1_1RCLValidatedLedger.html">RCLValidatedLedger</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLValidationsAdaptor.html#a1165a5474d2df3d127171a8ff7af3659">acquire</a> (<a class="el" href="namespaceripple.html#af5a72d3e0d9b6913c13f688390b90796">LedgerHash</a> const &amp;id)</td></tr>
<tr class="memdesc:a1165a5474d2df3d127171a8ff7af3659"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attempt to acquire the ledger with given id from the network. <a href="classripple_1_1RCLValidationsAdaptor.html#a1165a5474d2df3d127171a8ff7af3659">More...</a><br /></td></tr>
<tr class="separator:a1165a5474d2df3d127171a8ff7af3659"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0eebe32ebe8432114e6b1f32e0faf3ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLValidationsAdaptor.html#a0eebe32ebe8432114e6b1f32e0faf3ad">journal</a> () const</td></tr>
<tr class="separator:a0eebe32ebe8432114e6b1f32e0faf3ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a9d4064e21779edb561efd60fc7ad92af"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Application.html">Application</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLValidationsAdaptor.html#a9d4064e21779edb561efd60fc7ad92af">app_</a></td></tr>
<tr class="separator:a9d4064e21779edb561efd60fc7ad92af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe09a632ad7bb4fb77c1ce0cce5fd580"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLValidationsAdaptor.html#abe09a632ad7bb4fb77c1ce0cce5fd580">j_</a></td></tr>
<tr class="separator:abe09a632ad7bb4fb77c1ce0cce5fd580"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Generic validations adaptor class for RCL. </p>
<p >Manages storing and writing stale RCLValidations to the sqlite DB and acquiring validated ledgers from the network. </p>
<p class="definition">Definition at line <a class="el" href="RCLValidations_8h_source.html#l00209">209</a> of file <a class="el" href="RCLValidations_8h_source.html">RCLValidations.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a62a437d55991171e4f85b05163bb1598" name="a62a437d55991171e4f85b05163bb1598"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62a437d55991171e4f85b05163bb1598">&#9670;&#160;</a></span>Mutex</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1RCLValidationsAdaptor.html#a62a437d55991171e4f85b05163bb1598">ripple::RCLValidationsAdaptor::Mutex</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/thread/mutex.html">std::mutex</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="RCLValidations_8h_source.html#l00213">213</a> of file <a class="el" href="RCLValidations_8h_source.html">RCLValidations.h</a>.</p>
</div>
</div>
<a id="a717fb5de9c44c66e0091074e14420c39" name="a717fb5de9c44c66e0091074e14420c39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a717fb5de9c44c66e0091074e14420c39">&#9670;&#160;</a></span>Validation</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1RCLValidationsAdaptor.html#a717fb5de9c44c66e0091074e14420c39">ripple::RCLValidationsAdaptor::Validation</a> = <a class="el" href="classripple_1_1RCLValidation.html">RCLValidation</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="RCLValidations_8h_source.html#l00214">214</a> of file <a class="el" href="RCLValidations_8h_source.html">RCLValidations.h</a>.</p>
</div>
</div>
<a id="a24754bc4b2f8983fe37263ee543f66b0" name="a24754bc4b2f8983fe37263ee543f66b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24754bc4b2f8983fe37263ee543f66b0">&#9670;&#160;</a></span>Ledger</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1RCLValidationsAdaptor.html#a24754bc4b2f8983fe37263ee543f66b0">ripple::RCLValidationsAdaptor::Ledger</a> = <a class="el" href="classripple_1_1RCLValidatedLedger.html">RCLValidatedLedger</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="RCLValidations_8h_source.html#l00215">215</a> of file <a class="el" href="RCLValidations_8h_source.html">RCLValidations.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a642615a5ff0015b5cd42b215018f316f" name="a642615a5ff0015b5cd42b215018f316f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a642615a5ff0015b5cd42b215018f316f">&#9670;&#160;</a></span>RCLValidationsAdaptor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::RCLValidationsAdaptor::RCLValidationsAdaptor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Application.html">Application</a> &amp;&#160;</td>
<td class="paramname"><em>app</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td>
<td class="paramname"><em>j</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="RCLValidations_8cpp_source.html#l00119">119</a> of file <a class="el" href="RCLValidations_8cpp_source.html">RCLValidations.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a71524d4aa1389ba9021de51a375b5e82" name="a71524d4aa1389ba9021de51a375b5e82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71524d4aa1389ba9021de51a375b5e82">&#9670;&#160;</a></span>now()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1NetClock.html#a4c2428e178dca6689fa3fb4be0657107">NetClock::time_point</a> ripple::RCLValidationsAdaptor::now </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Current time used to determine if validations are stale. </p>
<p class="definition">Definition at line <a class="el" href="RCLValidations_8cpp_source.html#l00125">125</a> of file <a class="el" href="RCLValidations_8cpp_source.html">RCLValidations.cpp</a>.</p>
</div>
</div>
<a id="a1165a5474d2df3d127171a8ff7af3659" name="a1165a5474d2df3d127171a8ff7af3659"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1165a5474d2df3d127171a8ff7af3659">&#9670;&#160;</a></span>acquire()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; <a class="el" href="classripple_1_1RCLValidatedLedger.html">RCLValidatedLedger</a> &gt; ripple::RCLValidationsAdaptor::acquire </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#af5a72d3e0d9b6913c13f688390b90796">LedgerHash</a> const &amp;&#160;</td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempt to acquire the ledger with given id from the network. </p>
<p class="definition">Definition at line <a class="el" href="RCLValidations_8cpp_source.html#l00131">131</a> of file <a class="el" href="RCLValidations_8cpp_source.html">RCLValidations.cpp</a>.</p>
</div>
</div>
<a id="a0eebe32ebe8432114e6b1f32e0faf3ad" name="a0eebe32ebe8432114e6b1f32e0faf3ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0eebe32ebe8432114e6b1f32e0faf3ad">&#9670;&#160;</a></span>journal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> ripple::RCLValidationsAdaptor::journal </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="RCLValidations_8h_source.html#l00229">229</a> of file <a class="el" href="RCLValidations_8h_source.html">RCLValidations.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a9d4064e21779edb561efd60fc7ad92af" name="a9d4064e21779edb561efd60fc7ad92af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d4064e21779edb561efd60fc7ad92af">&#9670;&#160;</a></span>app_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1Application.html">Application</a>&amp; ripple::RCLValidationsAdaptor::app_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="RCLValidations_8h_source.html#l00235">235</a> of file <a class="el" href="RCLValidations_8h_source.html">RCLValidations.h</a>.</p>
</div>
</div>
<a id="abe09a632ad7bb4fb77c1ce0cce5fd580" name="abe09a632ad7bb4fb77c1ce0cce5fd580"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe09a632ad7bb4fb77c1ce0cce5fd580">&#9670;&#160;</a></span>j_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> ripple::RCLValidationsAdaptor::j_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="RCLValidations_8h_source.html#l00236">236</a> of file <a class="el" href="RCLValidations_8h_source.html">RCLValidations.h</a>.</p>
</div>
</div>
</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.5
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink