mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
482 lines
32 KiB
HTML
482 lines
32 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" 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::RCLCxLedger 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&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&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_1RCLCxLedger.html">RCLCxLedger</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="classripple_1_1RCLCxLedger-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">ripple::RCLCxLedger Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Represents a ledger in <a class="el" href="classripple_1_1RCLConsensus.html" title="Manages the generic consensus algorithm for use by the RCL.">RCLConsensus</a>.
|
|
<a href="classripple_1_1RCLCxLedger.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for ripple::RCLCxLedger:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1RCLCxLedger__coll__graph.png" border="0" usemap="#aripple_1_1RCLCxLedger_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="aripple_1_1RCLCxLedger_coll__map" id="aripple_1_1RCLCxLedger_coll__map">
|
|
<area shape="rect" title="Represents a ledger in RCLConsensus." alt="" coords="2696,449,2849,474"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="2424,441,2595,481"/>
|
|
<area shape="rect" href="classripple_1_1Ledger.html" title="Holds a ledger." alt="" coords="2197,449,2308,474"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html" title=" " alt="" coords="1841,416,2006,456"/>
|
|
<area shape="rect" href="classripple_1_1DigestAwareReadView.html" title="ReadView that associates keys with digests." alt="" coords="1816,710,2031,735"/>
|
|
<area shape="rect" href="classripple_1_1ReadView.html" title="A view into a ledger." alt="" coords="1559,826,1691,851"/>
|
|
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="1830,887,2017,927"/>
|
|
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="1835,760,2012,800"/>
|
|
<area shape="rect" href="structripple_1_1ReadView_1_1sles__type.html" title=" " alt="" coords="2152,930,2353,955"/>
|
|
<area shape="rect" href="structripple_1_1ReadView_1_1txs__type.html" title=" " alt="" coords="2155,809,2350,834"/>
|
|
<area shape="rect" href="classripple_1_1TxsRawView.html" title="Interface for changing ledger entries with transactions." alt="" coords="1848,362,1999,387"/>
|
|
<area shape="rect" href="classripple_1_1RawView.html" title="Interface for ledger entry changes." alt="" coords="1562,361,1689,386"/>
|
|
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="1842,596,2005,636"/>
|
|
<area shape="rect" href="classripple_1_1SHAMap.html" title="A SHAMap is both a radix tree with a fan-out of 16 and a Merkle tree." alt="" coords="1862,481,1985,506"/>
|
|
<area shape="rect" href="classripple_1_1Family.html" title=" " alt="" coords="1570,575,1681,601"/>
|
|
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="1570,526,1681,551"/>
|
|
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="1275,526,1422,551"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,441,108,466"/>
|
|
<area shape="rect" href="classripple_1_1SHAMapTreeNode.html" title=" " alt="" coords="1257,473,1440,498"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="250,613,418,653"/>
|
|
<area shape="rect" href="structripple_1_1LedgerHeader.html" title="Information about the notional ledger backing the view." alt="" coords="929,299,1088,325"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="1540,461,1711,501"/>
|
|
<area shape="rect" href="classripple_1_1SHAMapHash.html" title=" " alt="" coords="931,530,1086,555"/>
|
|
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="559,560,701,600"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="290,539,378,565"/>
|
|
<area shape="rect" href="classripple_1_1base__uint.html" title="Integers of any length that is a multiple of 32-bits." alt="" coords="559,653,701,693"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/mutex.html" title=" " alt="" coords="1877,186,1969,211"/>
|
|
<area shape="rect" href="structripple_1_1Fees.html" title="Reflects the fee settings for a particular ledger." alt="" coords="1136,198,1233,223"/>
|
|
<area shape="rect" href="classripple_1_1XRPAmount.html" title=" " alt="" coords="559,158,701,183"/>
|
|
<area shape="rect" title=" " alt="" coords="251,120,417,160"/>
|
|
<area shape="rect" title=" " alt="" coords="221,185,447,210"/>
|
|
<area shape="rect" title=" " alt="" coords="229,235,439,275"/>
|
|
<area shape="rect" title=" " alt="" coords="227,5,441,45"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="287,70,381,95"/>
|
|
<area shape="rect" href="classripple_1_1Rules.html" title="Rules controlling protocol behavior." alt="" coords="1872,661,1975,686"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="1540,661,1711,701"/>
|
|
<area shape="rect" href="classripple_1_1Rules_1_1Impl.html" title=" " alt="" coords="1279,679,1419,705"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_set.html" title=" " alt="" coords="905,587,1112,642"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_set.html" title=" " alt="" coords="934,666,1083,721"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="931,745,1086,785"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/chrono/time_point.html" title=" " alt="" coords="544,349,716,389"/>
|
|
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/chrono/duration.html" title=" " alt="" coords="552,235,708,275"/>
|
|
</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:a7bb654d6e2d8f3df2cf4bf5091a7d0eb"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#a7bb654d6e2d8f3df2cf4bf5091a7d0eb">ID</a> = <a class="el" href="namespaceripple.html#af5a72d3e0d9b6913c13f688390b90796">LedgerHash</a></td></tr>
|
|
<tr class="memdesc:a7bb654d6e2d8f3df2cf4bf5091a7d0eb"><td class="mdescLeft"> </td><td class="mdescRight">Unique identifier of a ledger. <a href="classripple_1_1RCLCxLedger.html#a7bb654d6e2d8f3df2cf4bf5091a7d0eb">More...</a><br /></td></tr>
|
|
<tr class="separator:a7bb654d6e2d8f3df2cf4bf5091a7d0eb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaad5276a8dd4c15270ed5b847cf511cd"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#aaad5276a8dd4c15270ed5b847cf511cd">Seq</a> = <a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a></td></tr>
|
|
<tr class="memdesc:aaad5276a8dd4c15270ed5b847cf511cd"><td class="mdescLeft"> </td><td class="mdescRight">Sequence number of a ledger. <a href="classripple_1_1RCLCxLedger.html#aaad5276a8dd4c15270ed5b847cf511cd">More...</a><br /></td></tr>
|
|
<tr class="separator:aaad5276a8dd4c15270ed5b847cf511cd"><td class="memSeparator" colspan="2"> </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:a82a3ffad24861fae7168a5890e691ac3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#a82a3ffad24861fae7168a5890e691ac3">RCLCxLedger</a> ()=default</td></tr>
|
|
<tr class="memdesc:a82a3ffad24861fae7168a5890e691ac3"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="classripple_1_1RCLCxLedger.html#a82a3ffad24861fae7168a5890e691ac3">More...</a><br /></td></tr>
|
|
<tr class="separator:a82a3ffad24861fae7168a5890e691ac3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a612799ae2590556cfacbf081a7a1b01d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#a612799ae2590556cfacbf081a7a1b01d">RCLCxLedger</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1Ledger.html">Ledger</a> const > const &l)</td></tr>
|
|
<tr class="memdesc:a612799ae2590556cfacbf081a7a1b01d"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classripple_1_1RCLCxLedger.html#a612799ae2590556cfacbf081a7a1b01d">More...</a><br /></td></tr>
|
|
<tr class="separator:a612799ae2590556cfacbf081a7a1b01d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a318d581c9dc0d0ba14d3877ab93b7547"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1RCLCxLedger.html#aaad5276a8dd4c15270ed5b847cf511cd">Seq</a> const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#a318d581c9dc0d0ba14d3877ab93b7547">seq</a> () const</td></tr>
|
|
<tr class="memdesc:a318d581c9dc0d0ba14d3877ab93b7547"><td class="mdescLeft"> </td><td class="mdescRight">Sequence number of the ledger. <a href="classripple_1_1RCLCxLedger.html#a318d581c9dc0d0ba14d3877ab93b7547">More...</a><br /></td></tr>
|
|
<tr class="separator:a318d581c9dc0d0ba14d3877ab93b7547"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a68fde18f10664613068897f012fb1314"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1RCLCxLedger.html#a7bb654d6e2d8f3df2cf4bf5091a7d0eb">ID</a> const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#a68fde18f10664613068897f012fb1314">id</a> () const</td></tr>
|
|
<tr class="memdesc:a68fde18f10664613068897f012fb1314"><td class="mdescLeft"> </td><td class="mdescRight">Unique identifier (hash) of this ledger. <a href="classripple_1_1RCLCxLedger.html#a68fde18f10664613068897f012fb1314">More...</a><br /></td></tr>
|
|
<tr class="separator:a68fde18f10664613068897f012fb1314"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab2949aac07fe37e7cb3b056698077d40"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1RCLCxLedger.html#a7bb654d6e2d8f3df2cf4bf5091a7d0eb">ID</a> const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#ab2949aac07fe37e7cb3b056698077d40">parentID</a> () const</td></tr>
|
|
<tr class="memdesc:ab2949aac07fe37e7cb3b056698077d40"><td class="mdescLeft"> </td><td class="mdescRight">Unique identifier (hash) of this ledger's parent. <a href="classripple_1_1RCLCxLedger.html#ab2949aac07fe37e7cb3b056698077d40">More...</a><br /></td></tr>
|
|
<tr class="separator:ab2949aac07fe37e7cb3b056698077d40"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a19f2fa230d7885111a6ef321a72558ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1NetClock.html#afe3767203cd971a00067671641bc7e16">NetClock::duration</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#a19f2fa230d7885111a6ef321a72558ac">closeTimeResolution</a> () const</td></tr>
|
|
<tr class="memdesc:a19f2fa230d7885111a6ef321a72558ac"><td class="mdescLeft"> </td><td class="mdescRight">Resolution used when calculating this ledger's close time. <a href="classripple_1_1RCLCxLedger.html#a19f2fa230d7885111a6ef321a72558ac">More...</a><br /></td></tr>
|
|
<tr class="separator:a19f2fa230d7885111a6ef321a72558ac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae41ed9f6c557c46d64fbd398b2f35652"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#ae41ed9f6c557c46d64fbd398b2f35652">closeAgree</a> () const</td></tr>
|
|
<tr class="memdesc:ae41ed9f6c557c46d64fbd398b2f35652"><td class="mdescLeft"> </td><td class="mdescRight">Whether consensus process agreed on close time of the ledger. <a href="classripple_1_1RCLCxLedger.html#ae41ed9f6c557c46d64fbd398b2f35652">More...</a><br /></td></tr>
|
|
<tr class="separator:ae41ed9f6c557c46d64fbd398b2f35652"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8c31440ae6e0832e39f4acb30c3734dd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1NetClock.html#a4c2428e178dca6689fa3fb4be0657107">NetClock::time_point</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#a8c31440ae6e0832e39f4acb30c3734dd">closeTime</a> () const</td></tr>
|
|
<tr class="memdesc:a8c31440ae6e0832e39f4acb30c3734dd"><td class="mdescLeft"> </td><td class="mdescRight">The close time of this ledger. <a href="classripple_1_1RCLCxLedger.html#a8c31440ae6e0832e39f4acb30c3734dd">More...</a><br /></td></tr>
|
|
<tr class="separator:a8c31440ae6e0832e39f4acb30c3734dd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a563a6ec2d0c01b8ade4a47dc9b7c8b73"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1NetClock.html#a4c2428e178dca6689fa3fb4be0657107">NetClock::time_point</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#a563a6ec2d0c01b8ade4a47dc9b7c8b73">parentCloseTime</a> () const</td></tr>
|
|
<tr class="memdesc:a563a6ec2d0c01b8ade4a47dc9b7c8b73"><td class="mdescLeft"> </td><td class="mdescRight">The close time of this ledger's parent. <a href="classripple_1_1RCLCxLedger.html#a563a6ec2d0c01b8ade4a47dc9b7c8b73">More...</a><br /></td></tr>
|
|
<tr class="separator:a563a6ec2d0c01b8ade4a47dc9b7c8b73"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aad38a2e710238aef4c8c3ba64c229aee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classJson_1_1Value.html">Json::Value</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#aad38a2e710238aef4c8c3ba64c229aee">getJson</a> () const</td></tr>
|
|
<tr class="memdesc:aad38a2e710238aef4c8c3ba64c229aee"><td class="mdescLeft"> </td><td class="mdescRight">JSON representation of this ledger. <a href="classripple_1_1RCLCxLedger.html#aad38a2e710238aef4c8c3ba64c229aee">More...</a><br /></td></tr>
|
|
<tr class="separator:aad38a2e710238aef4c8c3ba64c229aee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a790fedb2406a5d248f2188da3c421dbc"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1Ledger.html">Ledger</a> const > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxLedger.html#a790fedb2406a5d248f2188da3c421dbc">ledger_</a></td></tr>
|
|
<tr class="memdesc:a790fedb2406a5d248f2188da3c421dbc"><td class="mdescLeft"> </td><td class="mdescRight">The ledger instance. <a href="classripple_1_1RCLCxLedger.html#a790fedb2406a5d248f2188da3c421dbc">More...</a><br /></td></tr>
|
|
<tr class="separator:a790fedb2406a5d248f2188da3c421dbc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p >Represents a ledger in <a class="el" href="classripple_1_1RCLConsensus.html" title="Manages the generic consensus algorithm for use by the RCL.">RCLConsensus</a>. </p>
|
|
<p ><a class="el" href="classripple_1_1RCLCxLedger.html" title="Represents a ledger in RCLConsensus.">RCLCxLedger</a> is a thin wrapper over <code><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a><<a class="el" href="classripple_1_1Ledger.html" title="Holds a ledger.">Ledger</a> const></code>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00035">35</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="a7bb654d6e2d8f3df2cf4bf5091a7d0eb" name="a7bb654d6e2d8f3df2cf4bf5091a7d0eb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7bb654d6e2d8f3df2cf4bf5091a7d0eb">◆ </a></span>ID</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1RCLCxLedger.html#a7bb654d6e2d8f3df2cf4bf5091a7d0eb">ripple::RCLCxLedger::ID</a> = <a class="el" href="namespaceripple.html#af5a72d3e0d9b6913c13f688390b90796">LedgerHash</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Unique identifier of a ledger. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00039">39</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaad5276a8dd4c15270ed5b847cf511cd" name="aaad5276a8dd4c15270ed5b847cf511cd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaad5276a8dd4c15270ed5b847cf511cd">◆ </a></span>Seq</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1RCLCxLedger.html#aaad5276a8dd4c15270ed5b847cf511cd">ripple::RCLCxLedger::Seq</a> = <a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sequence number of a ledger. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00041">41</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a82a3ffad24861fae7168a5890e691ac3" name="a82a3ffad24861fae7168a5890e691ac3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a82a3ffad24861fae7168a5890e691ac3">◆ </a></span>RCLCxLedger() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ripple::RCLCxLedger::RCLCxLedger </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
<p >TODO: This may not be needed if we ensure <a class="el" href="classripple_1_1RCLConsensus.html" title="Manages the generic consensus algorithm for use by the RCL.">RCLConsensus</a> is handed a valid ledger in its constructor. Its bad now because other members are not checking whether the ledger is valid. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a612799ae2590556cfacbf081a7a1b01d" name="a612799ae2590556cfacbf081a7a1b01d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a612799ae2590556cfacbf081a7a1b01d">◆ </a></span>RCLCxLedger() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ripple::RCLCxLedger::RCLCxLedger </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1Ledger.html">Ledger</a> const > const & </td>
|
|
<td class="paramname"><em>l</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">l</td><td>The ledger to wrap. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00055">55</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a318d581c9dc0d0ba14d3877ab93b7547" name="a318d581c9dc0d0ba14d3877ab93b7547"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a318d581c9dc0d0ba14d3877ab93b7547">◆ </a></span>seq()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1RCLCxLedger.html#aaad5276a8dd4c15270ed5b847cf511cd">Seq</a> const & ripple::RCLCxLedger::seq </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sequence number of the ledger. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00061">61</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a68fde18f10664613068897f012fb1314" name="a68fde18f10664613068897f012fb1314"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a68fde18f10664613068897f012fb1314">◆ </a></span>id()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1RCLCxLedger.html#a7bb654d6e2d8f3df2cf4bf5091a7d0eb">ID</a> const & ripple::RCLCxLedger::id </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Unique identifier (hash) of this ledger. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00068">68</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab2949aac07fe37e7cb3b056698077d40" name="ab2949aac07fe37e7cb3b056698077d40"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab2949aac07fe37e7cb3b056698077d40">◆ </a></span>parentID()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1RCLCxLedger.html#a7bb654d6e2d8f3df2cf4bf5091a7d0eb">ID</a> const & ripple::RCLCxLedger::parentID </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Unique identifier (hash) of this ledger's parent. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00075">75</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a19f2fa230d7885111a6ef321a72558ac" name="a19f2fa230d7885111a6ef321a72558ac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a19f2fa230d7885111a6ef321a72558ac">◆ </a></span>closeTimeResolution()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1NetClock.html#afe3767203cd971a00067671641bc7e16">NetClock::duration</a> ripple::RCLCxLedger::closeTimeResolution </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Resolution used when calculating this ledger's close time. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00082">82</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae41ed9f6c557c46d64fbd398b2f35652" name="ae41ed9f6c557c46d64fbd398b2f35652"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae41ed9f6c557c46d64fbd398b2f35652">◆ </a></span>closeAgree()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ripple::RCLCxLedger::closeAgree </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Whether consensus process agreed on close time of the ledger. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00089">89</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8c31440ae6e0832e39f4acb30c3734dd" name="a8c31440ae6e0832e39f4acb30c3734dd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8c31440ae6e0832e39f4acb30c3734dd">◆ </a></span>closeTime()</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::RCLCxLedger::closeTime </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The close time of this ledger. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00096">96</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a563a6ec2d0c01b8ade4a47dc9b7c8b73" name="a563a6ec2d0c01b8ade4a47dc9b7c8b73"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a563a6ec2d0c01b8ade4a47dc9b7c8b73">◆ </a></span>parentCloseTime()</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::RCLCxLedger::parentCloseTime </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The close time of this ledger's parent. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00103">103</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aad38a2e710238aef4c8c3ba64c229aee" name="aad38a2e710238aef4c8c3ba64c229aee"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aad38a2e710238aef4c8c3ba64c229aee">◆ </a></span>getJson()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classJson_1_1Value.html">Json::Value</a> ripple::RCLCxLedger::getJson </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>JSON representation of this ledger. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00110">110</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a790fedb2406a5d248f2188da3c421dbc" name="a790fedb2406a5d248f2188da3c421dbc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a790fedb2406a5d248f2188da3c421dbc">◆ </a></span>ledger_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a><<a class="el" href="classripple_1_1Ledger.html">Ledger</a> const> ripple::RCLCxLedger::ledger_</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The ledger instance. </p>
|
|
<p >TODO: Make this shared_ptr<ReadView const> .. requires ability to create a new ledger from a readView? </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RCLCxLedger_8h_source.html#l00120">120</a> of file <a class="el" href="RCLCxLedger_8h_source.html">RCLCxLedger.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|