Files
rippled/classripple_1_1RCLTxSet_1_1MutableTxSet.html
2023-04-11 16:57:37 +00:00

264 lines
15 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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::RCLTxSet::MutableTxSet 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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</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_1RCLTxSet.html">RCLTxSet</a></li><li class="navelem"><a class="el" href="classripple_1_1RCLTxSet_1_1MutableTxSet.html">MutableTxSet</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classripple_1_1RCLTxSet_1_1MutableTxSet-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::RCLTxSet::MutableTxSet Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for ripple::RCLTxSet::MutableTxSet:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1RCLTxSet_1_1MutableTxSet__coll__graph.png" border="0" usemap="#ripple_1_1RCLTxSet_1_1MutableTxSet_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1RCLTxSet_1_1MutableTxSet_coll__map" id="ripple_1_1RCLTxSet_1_1MutableTxSet_coll__map">
<area shape="rect" title=" " alt="" coords="1975,103,2161,145"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="1715,103,1885,145"/>
<area shape="rect" href="classripple_1_1SHAMap.html" title="A SHAMap is both a radix tree with a fan&#45;out of 16 and a Merkle tree." alt="" coords="1523,111,1644,137"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,83,108,109"/>
<area shape="rect" href="classripple_1_1SHAMapTreeNode.html" title=" " alt="" coords="964,83,1147,109"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="221,134,389,175"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="1247,74,1417,115"/>
<area shape="rect" href="classripple_1_1SHAMapHash.html" title=" " alt="" coords="719,143,873,169"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="487,145,628,186"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="261,201,349,228"/>
<area shape="rect" href="classripple_1_1Family.html" title=" " alt="" coords="1277,140,1387,167"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="1277,191,1387,217"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="982,191,1129,217"/>
</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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a40208f5e2b910e8029c01622f3f43d17"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLTxSet_1_1MutableTxSet.html#a40208f5e2b910e8029c01622f3f43d17">MutableTxSet</a> (<a class="el" href="classripple_1_1RCLTxSet.html">RCLTxSet</a> const &amp;src)</td></tr>
<tr class="separator:a40208f5e2b910e8029c01622f3f43d17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a7e78d5009c441d0cb03ad1fa96af4c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLTxSet_1_1MutableTxSet.html#a5a7e78d5009c441d0cb03ad1fa96af4c">insert</a> (<a class="el" href="classripple_1_1RCLTxSet.html#a4b6da03b618a8963fc39f1a404a6d95d">Tx</a> const &amp;t)</td></tr>
<tr class="memdesc:a5a7e78d5009c441d0cb03ad1fa96af4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert a new transaction into the set. <a href="classripple_1_1RCLTxSet_1_1MutableTxSet.html#a5a7e78d5009c441d0cb03ad1fa96af4c">More...</a><br /></td></tr>
<tr class="separator:a5a7e78d5009c441d0cb03ad1fa96af4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaeb1840dbfd56d09763703048a531f23"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLTxSet_1_1MutableTxSet.html#aaeb1840dbfd56d09763703048a531f23">erase</a> (<a class="el" href="classripple_1_1RCLCxTx.html#af23a5fc53012f97206cc37602b3301ce">Tx::ID</a> const &amp;entry)</td></tr>
<tr class="memdesc:aaeb1840dbfd56d09763703048a531f23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove a transaction from the set. <a href="classripple_1_1RCLTxSet_1_1MutableTxSet.html#aaeb1840dbfd56d09763703048a531f23">More...</a><br /></td></tr>
<tr class="separator:aaeb1840dbfd56d09763703048a531f23"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:ac01bbc29be2927e78898903a96dc35a7"><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>&lt; <a class="el" href="classripple_1_1SHAMap.html">SHAMap</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLTxSet_1_1MutableTxSet.html#ac01bbc29be2927e78898903a96dc35a7">map_</a></td></tr>
<tr class="memdesc:ac01bbc29be2927e78898903a96dc35a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="classripple_1_1SHAMap.html" title="A SHAMap is both a radix tree with a fan-out of 16 and a Merkle tree.">SHAMap</a> representing the transactions. <a href="classripple_1_1RCLTxSet_1_1MutableTxSet.html#ac01bbc29be2927e78898903a96dc35a7">More...</a><br /></td></tr>
<tr class="separator:ac01bbc29be2927e78898903a96dc35a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ae77e0f98f13b953d575d7872bf6e1186"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLTxSet_1_1MutableTxSet.html#ae77e0f98f13b953d575d7872bf6e1186">RCLTxSet</a></td></tr>
<tr class="separator:ae77e0f98f13b953d575d7872bf6e1186"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="RCLCxTx_8h_source.html#l00074">74</a> of file <a class="el" href="RCLCxTx_8h_source.html">RCLCxTx.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a40208f5e2b910e8029c01622f3f43d17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40208f5e2b910e8029c01622f3f43d17">&#9670;&nbsp;</a></span>MutableTxSet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::RCLTxSet::MutableTxSet::MutableTxSet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1RCLTxSet.html">RCLTxSet</a> const &amp;&#160;</td>
<td class="paramname"><em>src</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="RCLCxTx_8h_source.html#l00081">81</a> of file <a class="el" href="RCLCxTx_8h_source.html">RCLCxTx.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a5a7e78d5009c441d0cb03ad1fa96af4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a7e78d5009c441d0cb03ad1fa96af4c">&#9670;&nbsp;</a></span>insert()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::RCLTxSet::MutableTxSet::insert </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1RCLTxSet.html#a4b6da03b618a8963fc39f1a404a6d95d">Tx</a> const &amp;&#160;</td>
<td class="paramname"><em>t</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Insert a new transaction into the set. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">t</td><td>The transaction to insert. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether the transaction took place. </dd></dl>
<p class="definition">Definition at line <a class="el" href="RCLCxTx_8h_source.html#l00091">91</a> of file <a class="el" href="RCLCxTx_8h_source.html">RCLCxTx.h</a>.</p>
</div>
</div>
<a id="aaeb1840dbfd56d09763703048a531f23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaeb1840dbfd56d09763703048a531f23">&#9670;&nbsp;</a></span>erase()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::RCLTxSet::MutableTxSet::erase </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1RCLCxTx.html#af23a5fc53012f97206cc37602b3301ce">Tx::ID</a> const &amp;&#160;</td>
<td class="paramname"><em>entry</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove a transaction from the set. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entry</td><td>The ID of the transaction to remove. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether the transaction was removed. </dd></dl>
<p class="definition">Definition at line <a class="el" href="RCLCxTx_8h_source.html#l00102">102</a> of file <a class="el" href="RCLCxTx_8h_source.html">RCLCxTx.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="ae77e0f98f13b953d575d7872bf6e1186"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae77e0f98f13b953d575d7872bf6e1186">&#9670;&nbsp;</a></span>RCLTxSet</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classripple_1_1RCLTxSet.html">RCLTxSet</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="RCLCxTx_8h_source.html#l00076">76</a> of file <a class="el" href="RCLCxTx_8h_source.html">RCLCxTx.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ac01bbc29be2927e78898903a96dc35a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac01bbc29be2927e78898903a96dc35a7">&#9670;&nbsp;</a></span>map_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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>&lt;<a class="el" href="classripple_1_1SHAMap.html">SHAMap</a>&gt; ripple::RCLTxSet::MutableTxSet::map_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The <a class="el" href="classripple_1_1SHAMap.html" title="A SHAMap is both a radix tree with a fan-out of 16 and a Merkle tree.">SHAMap</a> representing the transactions. </p>
<p class="definition">Definition at line <a class="el" href="RCLCxTx_8h_source.html#l00078">78</a> of file <a class="el" href="RCLCxTx_8h_source.html">RCLCxTx.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>