mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-20 11:05:54 +00:00
1006 lines
65 KiB
HTML
1006 lines
65 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.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>rippled: ripple::ReadView 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.8 -->
|
|
<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_1ReadView.html">ReadView</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<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_1ReadView-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">ripple::ReadView Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A view into a ledger.
|
|
<a href="classripple_1_1ReadView.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="ReadView_8h_source.html">ReadView.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for ripple::ReadView:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1ReadView__inherit__graph.png" border="0" usemap="#aripple_1_1ReadView_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="aripple_1_1ReadView_inherit__map" id="aripple_1_1ReadView_inherit__map">
|
|
<area shape="rect" title="A view into a ledger." alt="" coords="5,107,137,132"/>
|
|
<area shape="rect" href="classripple_1_1ApplyView.html" title="Writeable view to a ledger, for applying a transaction." alt="" coords="225,57,361,83"/>
|
|
<area shape="poly" title=" " alt="" coords="142,101,234,80,235,85,143,106"/>
|
|
<area shape="rect" href="classripple_1_1DigestAwareReadView.html" title="ReadView that associates keys with digests." alt="" coords="185,107,400,132"/>
|
|
<area shape="poly" title=" " alt="" coords="151,117,185,117,185,122,151,122"/>
|
|
<area shape="rect" href="classripple_1_1OpenView.html" title="Writable ledger view that accumulates state and tx changes." alt="" coords="226,156,359,181"/>
|
|
<area shape="poly" title=" " alt="" coords="143,132,235,153,234,159,142,138"/>
|
|
<area shape="rect" href="classripple_1_1detail_1_1ApplyViewBase.html" title=" " alt="" coords="452,56,665,81"/>
|
|
<area shape="poly" title=" " alt="" coords="374,67,452,67,452,72,374,72"/>
|
|
<area shape="rect" href="classripple_1_1ApplyViewImpl.html" title="Editable, discardable view that can build metadata for one tx." alt="" coords="725,5,890,31"/>
|
|
<area shape="poly" title=" " alt="" coords="635,51,744,28,745,33,636,56"/>
|
|
<area shape="rect" href="classripple_1_1PaymentSandbox.html" title="A wrapper which makes credits unavailable to balances." alt="" coords="717,55,897,80"/>
|
|
<area shape="poly" title=" " alt="" coords="679,65,717,65,717,70,679,71"/>
|
|
<area shape="rect" href="classripple_1_1Sandbox.html" title="Discardable, editable view to a ledger." alt="" coords="746,104,869,129"/>
|
|
<area shape="poly" title=" " alt="" coords="639,81,746,102,745,108,638,87"/>
|
|
<area shape="rect" href="classripple_1_1Ledger.html" title="Holds a ledger." alt="" coords="503,107,614,132"/>
|
|
<area shape="poly" title=" " alt="" coords="414,117,503,117,503,122,414,122"/>
|
|
<area shape="rect" href="classripple_1_1detail_1_1CachedViewImpl.html" title=" " alt="" coords="448,157,669,183"/>
|
|
<area shape="poly" title=" " alt="" coords="374,132,492,155,491,160,373,137"/>
|
|
<area shape="rect" href="classripple_1_1CachedView.html" title="Wraps a DigestAwareReadView to provide caching." alt="" coords="734,154,881,194"/>
|
|
<area shape="poly" title=" " alt="" coords="684,169,734,170,734,175,683,175"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for ripple::ReadView:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1ReadView__coll__graph.png" border="0" usemap="#aripple_1_1ReadView_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="aripple_1_1ReadView_coll__map" id="aripple_1_1ReadView_coll__map">
|
|
<area shape="rect" title="A view into a ledger." alt="" coords="5,103,137,129"/>
|
|
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="228,5,415,45"/>
|
|
<area shape="poly" title=" " alt="" coords="102,93,160,63,227,42,228,47,162,68,105,98"/>
|
|
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="233,195,410,235"/>
|
|
<area shape="poly" title=" " alt="" coords="99,136,128,158,162,178,197,190,233,200,232,205,195,195,160,182,125,162,96,140"/>
|
|
<area shape="rect" href="structripple_1_1ReadView_1_1sles__type.html" title=" " alt="" coords="464,55,665,81"/>
|
|
<area shape="poly" title=" " alt="" coords="451,82,138,112,138,107,450,76"/>
|
|
<area shape="poly" title=" " alt="" coords="428,41,492,53,491,58,427,47"/>
|
|
<area shape="rect" href="structripple_1_1ReadView_1_1txs__type.html" title=" " alt="" coords="467,150,662,175"/>
|
|
<area shape="poly" title=" " alt="" coords="453,155,138,125,138,120,454,150"/>
|
|
<area shape="poly" title=" " alt="" coords="423,190,504,173,505,178,424,195"/>
|
|
</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="nested-classes" name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ReadView_1_1sles__type.html">sles_type</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ReadView_1_1txs__type.html">txs_type</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:ab1430dec61fd5ef9bf4a013aab558d71" id="r_ab1430dec61fd5ef9bf4a013aab558d71"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#ab1430dec61fd5ef9bf4a013aab558d71">tx_type</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</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_1STTx.html">STTx</a> const >, <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="classripple_1_1STObject.html">STObject</a> const > ></td></tr>
|
|
<tr class="separator:ab1430dec61fd5ef9bf4a013aab558d71"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a937328125a7d62270f32b4e1555c5cdd" id="r_a937328125a7d62270f32b4e1555c5cdd"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> = <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a></td></tr>
|
|
<tr class="separator:a937328125a7d62270f32b4e1555c5cdd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c7268164504d76bee886f296b15e814" id="r_a0c7268164504d76bee886f296b15e814"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a0c7268164504d76bee886f296b15e814">mapped_type</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> const ></td></tr>
|
|
<tr class="separator:a0c7268164504d76bee886f296b15e814"><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:a317c491e4316dc908a6cc5fa38ecb810" id="r_a317c491e4316dc908a6cc5fa38ecb810"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a317c491e4316dc908a6cc5fa38ecb810">~ReadView</a> ()=default</td></tr>
|
|
<tr class="separator:a317c491e4316dc908a6cc5fa38ecb810"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2c5808c2d2f79b0aed2f24ee1fd91140" id="r_a2c5808c2d2f79b0aed2f24ee1fd91140"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1ReadView.html">ReadView</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a2c5808c2d2f79b0aed2f24ee1fd91140">operator=</a> (<a class="el" href="classripple_1_1ReadView.html">ReadView</a> &&other)=delete</td></tr>
|
|
<tr class="separator:a2c5808c2d2f79b0aed2f24ee1fd91140"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4dce8990675a664edac8fa76dd985060" id="r_a4dce8990675a664edac8fa76dd985060"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1ReadView.html">ReadView</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a4dce8990675a664edac8fa76dd985060">operator=</a> (<a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &other)=delete</td></tr>
|
|
<tr class="separator:a4dce8990675a664edac8fa76dd985060"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae82132b2e82cb902cb5b67141e606700" id="r_ae82132b2e82cb902cb5b67141e606700"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#ae82132b2e82cb902cb5b67141e606700">ReadView</a> ()</td></tr>
|
|
<tr class="separator:ae82132b2e82cb902cb5b67141e606700"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aea4d77502713efa46beefad8db7537e1" id="r_aea4d77502713efa46beefad8db7537e1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#aea4d77502713efa46beefad8db7537e1">ReadView</a> (<a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &other)</td></tr>
|
|
<tr class="separator:aea4d77502713efa46beefad8db7537e1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0d72ac0da6f6cfb4d89bf8ae916f6cc4" id="r_a0d72ac0da6f6cfb4d89bf8ae916f6cc4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a0d72ac0da6f6cfb4d89bf8ae916f6cc4">ReadView</a> (<a class="el" href="classripple_1_1ReadView.html">ReadView</a> &&other)</td></tr>
|
|
<tr class="separator:a0d72ac0da6f6cfb4d89bf8ae916f6cc4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aca9d5e022d68fdd94bf3c8e36a294a96" id="r_aca9d5e022d68fdd94bf3c8e36a294a96"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceripple.html#aaf521cde20561da32d6a54a105363555">LedgerInfo</a> const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#aca9d5e022d68fdd94bf3c8e36a294a96">info</a> () const =0</td></tr>
|
|
<tr class="memdesc:aca9d5e022d68fdd94bf3c8e36a294a96"><td class="mdescLeft"> </td><td class="mdescRight">Returns information about the ledger. <br /></td></tr>
|
|
<tr class="separator:aca9d5e022d68fdd94bf3c8e36a294a96"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8dc63ee1e4ae7b2f96823e146c53d03e" id="r_a8dc63ee1e4ae7b2f96823e146c53d03e"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a8dc63ee1e4ae7b2f96823e146c53d03e">open</a> () const =0</td></tr>
|
|
<tr class="memdesc:a8dc63ee1e4ae7b2f96823e146c53d03e"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this reflects an open ledger. <br /></td></tr>
|
|
<tr class="separator:a8dc63ee1e4ae7b2f96823e146c53d03e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1427aa6cbbda99c50b9ca0ebf6e0d0b3" id="r_a1427aa6cbbda99c50b9ca0ebf6e0d0b3"><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_1ReadView.html#a1427aa6cbbda99c50b9ca0ebf6e0d0b3">parentCloseTime</a> () const</td></tr>
|
|
<tr class="memdesc:a1427aa6cbbda99c50b9ca0ebf6e0d0b3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the close time of the previous ledger. <br /></td></tr>
|
|
<tr class="separator:a1427aa6cbbda99c50b9ca0ebf6e0d0b3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac284afc905c482953c35c61b459fd85b" id="r_ac284afc905c482953c35c61b459fd85b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#ac284afc905c482953c35c61b459fd85b">seq</a> () const</td></tr>
|
|
<tr class="memdesc:ac284afc905c482953c35c61b459fd85b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the sequence number of the base ledger. <br /></td></tr>
|
|
<tr class="separator:ac284afc905c482953c35c61b459fd85b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9944284a00f671a4a9d9e00f9b28b258" id="r_a9944284a00f671a4a9d9e00f9b28b258"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structripple_1_1Fees.html">Fees</a> const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a9944284a00f671a4a9d9e00f9b28b258">fees</a> () const =0</td></tr>
|
|
<tr class="memdesc:a9944284a00f671a4a9d9e00f9b28b258"><td class="mdescLeft"> </td><td class="mdescRight">Returns the fees for the base ledger. <br /></td></tr>
|
|
<tr class="separator:a9944284a00f671a4a9d9e00f9b28b258"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aceb3d74acaae18b238022337e5f250ce" id="r_aceb3d74acaae18b238022337e5f250ce"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classripple_1_1Rules.html">Rules</a> const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#aceb3d74acaae18b238022337e5f250ce">rules</a> () const =0</td></tr>
|
|
<tr class="memdesc:aceb3d74acaae18b238022337e5f250ce"><td class="mdescLeft"> </td><td class="mdescRight">Returns the tx processing rules. <br /></td></tr>
|
|
<tr class="separator:aceb3d74acaae18b238022337e5f250ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac1d377c35a8332d069b09be8f4008dec" id="r_ac1d377c35a8332d069b09be8f4008dec"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#ac1d377c35a8332d069b09be8f4008dec">exists</a> (<a class="el" href="structripple_1_1Keylet.html">Keylet</a> const &k) const =0</td></tr>
|
|
<tr class="memdesc:ac1d377c35a8332d069b09be8f4008dec"><td class="mdescLeft"> </td><td class="mdescRight">Determine if a state item exists. <br /></td></tr>
|
|
<tr class="separator:ac1d377c35a8332d069b09be8f4008dec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a15b3629cee45ef3f5af4cef06f42e54a" id="r_a15b3629cee45ef3f5af4cef06f42e54a"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a15b3629cee45ef3f5af4cef06f42e54a">succ</a> (<a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> const &key, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> > const &last=<a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::nullopt</a>) const =0</td></tr>
|
|
<tr class="memdesc:a15b3629cee45ef3f5af4cef06f42e54a"><td class="mdescLeft"> </td><td class="mdescRight">Return the key of the next state item. <br /></td></tr>
|
|
<tr class="separator:a15b3629cee45ef3f5af4cef06f42e54a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0583a050ea7799ba331f6222a905f304" id="r_a0583a050ea7799ba331f6222a905f304"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> const > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a0583a050ea7799ba331f6222a905f304">read</a> (<a class="el" href="structripple_1_1Keylet.html">Keylet</a> const &k) const =0</td></tr>
|
|
<tr class="memdesc:a0583a050ea7799ba331f6222a905f304"><td class="mdescLeft"> </td><td class="mdescRight">Return the state item associated with a key. <br /></td></tr>
|
|
<tr class="separator:a0583a050ea7799ba331f6222a905f304"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a81e1b7628e44e758a0359061c4b17c96" id="r_a81e1b7628e44e758a0359061c4b17c96"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classripple_1_1STAmount.html">STAmount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a81e1b7628e44e758a0359061c4b17c96">balanceHook</a> (<a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &account, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &issuer, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amount) const</td></tr>
|
|
<tr class="separator:a81e1b7628e44e758a0359061c4b17c96"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6989ce9f6240d5c600d3a4f526f89d29" id="r_a6989ce9f6240d5c600d3a4f526f89d29"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a6989ce9f6240d5c600d3a4f526f89d29">ownerCountHook</a> (<a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &account, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> count) const</td></tr>
|
|
<tr class="separator:a6989ce9f6240d5c600d3a4f526f89d29"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae42d4f16315f6e357fbaf7157991470a" id="r_ae42d4f16315f6e357fbaf7157991470a"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< <a class="el" href="classripple_1_1detail_1_1ReadViewFwdRange.html#ad0e2a978fcfc47b2a937b536f1ed948f">sles_type::iter_base</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#ae42d4f16315f6e357fbaf7157991470a">slesBegin</a> () const =0</td></tr>
|
|
<tr class="separator:ae42d4f16315f6e357fbaf7157991470a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ca795f655eb8b6b9ade9c1634e0ef17" id="r_a4ca795f655eb8b6b9ade9c1634e0ef17"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< <a class="el" href="classripple_1_1detail_1_1ReadViewFwdRange.html#ad0e2a978fcfc47b2a937b536f1ed948f">sles_type::iter_base</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a4ca795f655eb8b6b9ade9c1634e0ef17">slesEnd</a> () const =0</td></tr>
|
|
<tr class="separator:a4ca795f655eb8b6b9ade9c1634e0ef17"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1903bd286e89d517dcec9fcbef5e7e32" id="r_a1903bd286e89d517dcec9fcbef5e7e32"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< <a class="el" href="classripple_1_1detail_1_1ReadViewFwdRange.html#ad0e2a978fcfc47b2a937b536f1ed948f">sles_type::iter_base</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a1903bd286e89d517dcec9fcbef5e7e32">slesUpperBound</a> (<a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> const &key) const =0</td></tr>
|
|
<tr class="separator:a1903bd286e89d517dcec9fcbef5e7e32"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d146422823dc32b9e846be1ddc8f318" id="r_a1d146422823dc32b9e846be1ddc8f318"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< <a class="el" href="classripple_1_1detail_1_1ReadViewFwdRange.html#ad0e2a978fcfc47b2a937b536f1ed948f">txs_type::iter_base</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a1d146422823dc32b9e846be1ddc8f318">txsBegin</a> () const =0</td></tr>
|
|
<tr class="separator:a1d146422823dc32b9e846be1ddc8f318"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adc67c7456b33e839513ef233845846d9" id="r_adc67c7456b33e839513ef233845846d9"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< <a class="el" href="classripple_1_1detail_1_1ReadViewFwdRange.html#ad0e2a978fcfc47b2a937b536f1ed948f">txs_type::iter_base</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#adc67c7456b33e839513ef233845846d9">txsEnd</a> () const =0</td></tr>
|
|
<tr class="separator:adc67c7456b33e839513ef233845846d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af95bff423d062ed89665e9f628972ece" id="r_af95bff423d062ed89665e9f628972ece"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#af95bff423d062ed89665e9f628972ece">txExists</a> (<a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> const &key) const =0</td></tr>
|
|
<tr class="memdesc:af95bff423d062ed89665e9f628972ece"><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if a tx exists in the tx map. <br /></td></tr>
|
|
<tr class="separator:af95bff423d062ed89665e9f628972ece"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af88b035a71531a9b27ee2fa25d0444e9" id="r_af88b035a71531a9b27ee2fa25d0444e9"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classripple_1_1ReadView.html#ab1430dec61fd5ef9bf4a013aab558d71">tx_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#af88b035a71531a9b27ee2fa25d0444e9">txRead</a> (<a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> const &key) const =0</td></tr>
|
|
<tr class="memdesc:af88b035a71531a9b27ee2fa25d0444e9"><td class="mdescLeft"> </td><td class="mdescRight">Read a transaction from the tx map. <br /></td></tr>
|
|
<tr class="separator:af88b035a71531a9b27ee2fa25d0444e9"><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:afd166083a5c60300819b4385d92e51cb" id="r_afd166083a5c60300819b4385d92e51cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1ReadView_1_1sles__type.html">sles_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#afd166083a5c60300819b4385d92e51cb">sles</a></td></tr>
|
|
<tr class="memdesc:afd166083a5c60300819b4385d92e51cb"><td class="mdescLeft"> </td><td class="mdescRight">Iterable range of ledger state items. <br /></td></tr>
|
|
<tr class="separator:afd166083a5c60300819b4385d92e51cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c70dc4b36e757ed6472b0aef460d858" id="r_a5c70dc4b36e757ed6472b0aef460d858"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1ReadView_1_1txs__type.html">txs_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ReadView.html#a5c70dc4b36e757ed6472b0aef460d858">txs</a></td></tr>
|
|
<tr class="separator:a5c70dc4b36e757ed6472b0aef460d858"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>A view into a ledger. </p>
|
|
<p>This interface provides read access to state and transaction items. There is no checkpointing or calculation of metadata. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00050">50</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="ab1430dec61fd5ef9bf4a013aab558d71" name="ab1430dec61fd5ef9bf4a013aab558d71"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab1430dec61fd5ef9bf4a013aab558d71">◆ </a></span>tx_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1ReadView.html#ab1430dec61fd5ef9bf4a013aab558d71">ripple::ReadView::tx_type</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</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_1STTx.html">STTx</a> const>, <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a><<a class="el" href="classripple_1_1STObject.html">STObject</a> const> ></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00053">53</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a937328125a7d62270f32b4e1555c5cdd" name="a937328125a7d62270f32b4e1555c5cdd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a937328125a7d62270f32b4e1555c5cdd">◆ </a></span>key_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">ripple::ReadView::key_type</a> = <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00056">56</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0c7268164504d76bee886f296b15e814" name="a0c7268164504d76bee886f296b15e814"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0c7268164504d76bee886f296b15e814">◆ </a></span>mapped_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="classripple_1_1ReadView.html#a0c7268164504d76bee886f296b15e814">ripple::ReadView::mapped_type</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a><<a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> const></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00058">58</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a317c491e4316dc908a6cc5fa38ecb810" name="a317c491e4316dc908a6cc5fa38ecb810"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a317c491e4316dc908a6cc5fa38ecb810">◆ </a></span>~ReadView()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual ripple::ReadView::~ReadView </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae82132b2e82cb902cb5b67141e606700" name="ae82132b2e82cb902cb5b67141e606700"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae82132b2e82cb902cb5b67141e606700">◆ </a></span>ReadView() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ripple::ReadView::ReadView </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00089">89</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aea4d77502713efa46beefad8db7537e1" name="aea4d77502713efa46beefad8db7537e1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aea4d77502713efa46beefad8db7537e1">◆ </a></span>ReadView() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ripple::ReadView::ReadView </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1ReadView.html">ReadView</a> const & </td>
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00093">93</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0d72ac0da6f6cfb4d89bf8ae916f6cc4" name="a0d72ac0da6f6cfb4d89bf8ae916f6cc4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0d72ac0da6f6cfb4d89bf8ae916f6cc4">◆ </a></span>ReadView() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ripple::ReadView::ReadView </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1ReadView.html">ReadView</a> && </td>
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00097">97</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a2c5808c2d2f79b0aed2f24ee1fd91140" name="a2c5808c2d2f79b0aed2f24ee1fd91140"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2c5808c2d2f79b0aed2f24ee1fd91140">◆ </a></span>operator=() <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"><a class="el" href="classripple_1_1ReadView.html">ReadView</a> & ripple::ReadView::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1ReadView.html">ReadView</a> && </td>
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4dce8990675a664edac8fa76dd985060" name="a4dce8990675a664edac8fa76dd985060"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4dce8990675a664edac8fa76dd985060">◆ </a></span>operator=() <span class="overload">[2/2]</span></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_1ReadView.html">ReadView</a> & ripple::ReadView::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1ReadView.html">ReadView</a> const & </td>
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aca9d5e022d68fdd94bf3c8e36a294a96" name="aca9d5e022d68fdd94bf3c8e36a294a96"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aca9d5e022d68fdd94bf3c8e36a294a96">◆ </a></span>info()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="namespaceripple.html#aaf521cde20561da32d6a54a105363555">LedgerInfo</a> const & ripple::ReadView::info </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns information about the ledger. </p>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#a670216d23345c14bc5c1cb055b81aea2">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a6ce0efb30729b08c4794b00a51e59aa5">ripple::detail::ApplyViewBase</a>, <a class="el" href="classripple_1_1OpenView.html#a3cfed3b0da284339dcdd02b50dcafa6f">ripple::OpenView</a>, and <a class="el" href="classripple_1_1Ledger.html#a008804ecb39a09e9e0cc906044bcc64c">ripple::Ledger</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8dc63ee1e4ae7b2f96823e146c53d03e" name="a8dc63ee1e4ae7b2f96823e146c53d03e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8dc63ee1e4ae7b2f96823e146c53d03e">◆ </a></span>open()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool ripple::ReadView::open </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true if this reflects an open ledger. </p>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#afb1c7f57990c69df15950a4d83babc4c">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a4af2aa917f94d3f031d8e53c3211f9e1">ripple::detail::ApplyViewBase</a>, <a class="el" href="classripple_1_1OpenView.html#aea54a965aa77bcd1f3cdb34c24176cb6">ripple::OpenView</a>, and <a class="el" href="classripple_1_1Ledger.html#a131fb72a0a470e6b493865f9a06762c4">ripple::Ledger</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1427aa6cbbda99c50b9ca0ebf6e0d0b3" name="a1427aa6cbbda99c50b9ca0ebf6e0d0b3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1427aa6cbbda99c50b9ca0ebf6e0d0b3">◆ </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::ReadView::parentCloseTime </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the close time of the previous ledger. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00111">111</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac284afc905c482953c35c61b459fd85b" name="ac284afc905c482953c35c61b459fd85b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac284afc905c482953c35c61b459fd85b">◆ </a></span>seq()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#a12af8e98b794e8ee3b4dbecaed2a4efd">LedgerIndex</a> ripple::ReadView::seq </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the sequence number of the base ledger. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00118">118</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9944284a00f671a4a9d9e00f9b28b258" name="a9944284a00f671a4a9d9e00f9b28b258"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9944284a00f671a4a9d9e00f9b28b258">◆ </a></span>fees()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="structripple_1_1Fees.html">Fees</a> const & ripple::ReadView::fees </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the fees for the base ledger. </p>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#aeda7788af08abf38fbd3e156db58faf3">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a08bb2668a3260801e8f7d85b4242eb6c">ripple::detail::ApplyViewBase</a>, <a class="el" href="classripple_1_1OpenView.html#af5f70f90ab27cd12ed017a4e1d2494b1">ripple::OpenView</a>, and <a class="el" href="classripple_1_1Ledger.html#a69a7d74ebc864270b4d4f636c539f78d">ripple::Ledger</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aceb3d74acaae18b238022337e5f250ce" name="aceb3d74acaae18b238022337e5f250ce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aceb3d74acaae18b238022337e5f250ce">◆ </a></span>rules()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classripple_1_1Rules.html">Rules</a> const & ripple::ReadView::rules </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the tx processing rules. </p>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#ae09b56129812843907916ceea46a78d2">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#af16244cf2efd903b4575a0b85c94d159">ripple::detail::ApplyViewBase</a>, <a class="el" href="classripple_1_1OpenView.html#a9b6ad540708bc720bdd66164078e640a">ripple::OpenView</a>, and <a class="el" href="classripple_1_1Ledger.html#a9e498a76456a43e4a021e47c35adad5e">ripple::Ledger</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac1d377c35a8332d069b09be8f4008dec" name="ac1d377c35a8332d069b09be8f4008dec"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac1d377c35a8332d069b09be8f4008dec">◆ </a></span>exists()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool ripple::ReadView::exists </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1Keylet.html">Keylet</a> const & </td>
|
|
<td class="paramname"><em>k</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determine if a state item exists. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This can be more efficient than calling read.</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if a SLE is associated with the specified key. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#a68bb9ce15af8016d45d70129fb269078">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#ab5b90b656223e19272dfe10e2dcd7f56">ripple::detail::ApplyViewBase</a>, <a class="el" href="classripple_1_1OpenView.html#a8b67b4e594ed8c96dfcf0d5dc895d0a2">ripple::OpenView</a>, and <a class="el" href="classripple_1_1Ledger.html#a196e844a1c5a015af934bd864690a1e2">ripple::Ledger</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a15b3629cee45ef3f5af4cef06f42e54a" name="a15b3629cee45ef3f5af4cef06f42e54a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a15b3629cee45ef3f5af4cef06f42e54a">◆ </a></span>succ()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> > ripple::ReadView::succ </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> const & </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> > const & </td>
|
|
<td class="paramname"><em>last</em> = <code><a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::nullopt</a></code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return the key of the next state item. </p>
|
|
<p>This returns the key of the first state item whose key is greater than the specified key. If no such key is present, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::nullopt</a> is returned.</p>
|
|
<p>If <code>last</code> is engaged, returns <a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::nullopt</a> when the key returned would be outside the open interval (key, last). </p>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#a875950bc040b2704243d0a6ac9107ed4">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#abb4191e08ea906c3074d4020ad6c8fde">ripple::detail::ApplyViewBase</a>, and <a class="el" href="classripple_1_1OpenView.html#a76b4e313ced46f6caaff0b53da2298bb">ripple::OpenView</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0583a050ea7799ba331f6222a905f304" name="a0583a050ea7799ba331f6222a905f304"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0583a050ea7799ba331f6222a905f304">◆ </a></span>read()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>< <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> const > ripple::ReadView::read </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1Keylet.html">Keylet</a> const & </td>
|
|
<td class="paramname"><em>k</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return the state item associated with a key. </p>
|
|
<p>Effects: If the key exists, gives the caller ownership of the non-modifiable corresponding SLE.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>While the returned SLE is <code>const</code> from the perspective of the caller, it can be changed by other callers through raw operations.</dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>nullptr</code> if the key is not present or if the type does not match. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#a582680a14129f2d3e08018a3044a0b4b">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#adbca64f4c123b0fbcfdf27586649732b">ripple::detail::ApplyViewBase</a>, <a class="el" href="classripple_1_1OpenView.html#a9db14117eadad3eefc95f1b584ecda8d">ripple::OpenView</a>, and <a class="el" href="classripple_1_1Ledger.html#a945ead8d34dfdb0a2b01ae3125afa8eb">ripple::Ledger</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a81e1b7628e44e758a0359061c4b17c96" name="a81e1b7628e44e758a0359061c4b17c96"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a81e1b7628e44e758a0359061c4b17c96">◆ </a></span>balanceHook()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classripple_1_1STAmount.html">STAmount</a> ripple::ReadView::balanceHook </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const & </td>
|
|
<td class="paramname"><em>account</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const & </td>
|
|
<td class="paramname"><em>issuer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const & </td>
|
|
<td class="paramname"><em>amount</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reimplemented in <a class="el" href="classripple_1_1PaymentSandbox.html#a96457b37722d895c585bcd260dd08a0f">ripple::PaymentSandbox</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00178">178</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6989ce9f6240d5c600d3a4f526f89d29" name="a6989ce9f6240d5c600d3a4f526f89d29"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6989ce9f6240d5c600d3a4f526f89d29">◆ </a></span>ownerCountHook()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ripple::ReadView::ownerCountHook </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const & </td>
|
|
<td class="paramname"><em>account</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> </td>
|
|
<td class="paramname"><em>count</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reimplemented in <a class="el" href="classripple_1_1PaymentSandbox.html#a0e77b6bdc540075e1c8e5a6f447c4b13">ripple::PaymentSandbox</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00192">192</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae42d4f16315f6e357fbaf7157991470a" name="ae42d4f16315f6e357fbaf7157991470a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae42d4f16315f6e357fbaf7157991470a">◆ </a></span>slesBegin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< <a class="el" href="classripple_1_1detail_1_1ReadViewFwdRange.html#ad0e2a978fcfc47b2a937b536f1ed948f">sles_type::iter_base</a> > ripple::ReadView::slesBegin </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#a92207fdd1c5a69fafd770f23e4355fb7">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a84a5864b69739165cd7d711a49a457c1">ripple::detail::ApplyViewBase</a>, <a class="el" href="classripple_1_1OpenView.html#aa8f657e95982e0f69f5b1476119ad76f">ripple::OpenView</a>, and <a class="el" href="classripple_1_1Ledger.html#aa83dfb46c969cf85cba5ca889b5cf7d6">ripple::Ledger</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4ca795f655eb8b6b9ade9c1634e0ef17" name="a4ca795f655eb8b6b9ade9c1634e0ef17"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4ca795f655eb8b6b9ade9c1634e0ef17">◆ </a></span>slesEnd()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< <a class="el" href="classripple_1_1detail_1_1ReadViewFwdRange.html#ad0e2a978fcfc47b2a937b536f1ed948f">sles_type::iter_base</a> > ripple::ReadView::slesEnd </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#ac6183b176e9072137a45972a748914ac">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a69dc208d6b5afb41607fde91bcabc018">ripple::detail::ApplyViewBase</a>, <a class="el" href="classripple_1_1OpenView.html#a5dff0c0a73e494964e1f2e30cec4181e">ripple::OpenView</a>, and <a class="el" href="classripple_1_1Ledger.html#a220660a0e999b374e502b117ae93833f">ripple::Ledger</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1903bd286e89d517dcec9fcbef5e7e32" name="a1903bd286e89d517dcec9fcbef5e7e32"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1903bd286e89d517dcec9fcbef5e7e32">◆ </a></span>slesUpperBound()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< <a class="el" href="classripple_1_1detail_1_1ReadViewFwdRange.html#ad0e2a978fcfc47b2a937b536f1ed948f">sles_type::iter_base</a> > ripple::ReadView::slesUpperBound </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> const & </td>
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1d146422823dc32b9e846be1ddc8f318" name="a1d146422823dc32b9e846be1ddc8f318"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1d146422823dc32b9e846be1ddc8f318">◆ </a></span>txsBegin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< <a class="el" href="classripple_1_1detail_1_1ReadViewFwdRange.html#ad0e2a978fcfc47b2a937b536f1ed948f">txs_type::iter_base</a> > ripple::ReadView::txsBegin </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#a753ef4b364431985f504669c8fc142cc">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a960d0fe7b6a20c4bbc4041830eb77a54">ripple::detail::ApplyViewBase</a>, <a class="el" href="classripple_1_1OpenView.html#af5368511bd160054aaeaa9ca6145951c">ripple::OpenView</a>, and <a class="el" href="classripple_1_1Ledger.html#ad0ae3a298b1fc8b7b45524f86fed514f">ripple::Ledger</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adc67c7456b33e839513ef233845846d9" name="adc67c7456b33e839513ef233845846d9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adc67c7456b33e839513ef233845846d9">◆ </a></span>txsEnd()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>< <a class="el" href="classripple_1_1detail_1_1ReadViewFwdRange.html#ad0e2a978fcfc47b2a937b536f1ed948f">txs_type::iter_base</a> > ripple::ReadView::txsEnd </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#a1b008fe9cb5458491e009407f803bf9a">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a239ae0136ad4bf2b6d71e4bb195941b6">ripple::detail::ApplyViewBase</a>, <a class="el" href="classripple_1_1OpenView.html#af8d49b5de0ac18aa287d057daa594f0f">ripple::OpenView</a>, and <a class="el" href="classripple_1_1Ledger.html#acaf4d523fa7525606f7b1e576cf048c5">ripple::Ledger</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af95bff423d062ed89665e9f628972ece" name="af95bff423d062ed89665e9f628972ece"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af95bff423d062ed89665e9f628972ece">◆ </a></span>txExists()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool ripple::ReadView::txExists </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> const & </td>
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns <code>true</code> if a tx exists in the tx map. </p>
|
|
<p>A tx exists in the map if it is part of the base ledger, or if it is a newly inserted tx. </p>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#a5315d4aaf5a02b646e44cbc28cfca9ec">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#ad7cd53575d79dd8f0bf93a0143957b9d">ripple::detail::ApplyViewBase</a>, and <a class="el" href="classripple_1_1OpenView.html#a2294a6339fc789d88ca4b155a493c71a">ripple::OpenView</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af88b035a71531a9b27ee2fa25d0444e9" name="af88b035a71531a9b27ee2fa25d0444e9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af88b035a71531a9b27ee2fa25d0444e9">◆ </a></span>txRead()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classripple_1_1ReadView.html#ab1430dec61fd5ef9bf4a013aab558d71">tx_type</a> ripple::ReadView::txRead </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">key_type</a> const & </td>
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read a transaction from the tx map. </p>
|
|
<p>If the view represents an open ledger, the metadata object will be empty.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pair of nullptr if the key is not found in the tx map. </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1CachedViewImpl.html#a27043f0ad97acde4fc0e2fc6103d4f85">ripple::detail::CachedViewImpl</a>, <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a7da423c0d9af7e21383bffd56059aba3">ripple::detail::ApplyViewBase</a>, <a class="el" href="classripple_1_1OpenView.html#a16e0ecf8af65a3d89350dcfdb77ea1d1">ripple::OpenView</a>, and <a class="el" href="classripple_1_1Ledger.html#a6cf0862134638e77b99e53c25c41f3a9">ripple::Ledger</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="afd166083a5c60300819b4385d92e51cb" name="afd166083a5c60300819b4385d92e51cb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afd166083a5c60300819b4385d92e51cb">◆ </a></span>sles</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structripple_1_1ReadView_1_1sles__type.html">sles_type</a> ripple::ReadView::sles</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Iterable range of ledger state items. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Visiting each state entry in the ledger can become quite expensive as the ledger grows. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00245">245</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5c70dc4b36e757ed6472b0aef460d858" name="a5c70dc4b36e757ed6472b0aef460d858"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5c70dc4b36e757ed6472b0aef460d858">◆ </a></span>txs</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structripple_1_1ReadView_1_1txs__type.html">txs_type</a> ripple::ReadView::txs</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="ReadView_8h_source.html#l00248">248</a> of file <a class="el" href="ReadView_8h_source.html">ReadView.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.8
|
|
</small></address>
|
|
</body>
|
|
</html>
|