ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-30 07:55:51 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/classripple_1_1RCLTxSet.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

407 lines
27 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::RCLTxSet 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&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1RCLTxSet.html">RCLTxSet</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classripple_1_1RCLTxSet-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::RCLTxSet Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Represents a set of transactions 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_1RCLTxSet.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="RCLCxTx_8h_source.html">RCLCxTx.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::RCLTxSet:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1RCLTxSet__coll__graph.png" border="0" usemap="#aripple_1_1RCLTxSet_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1RCLTxSet_coll__map" id="aripple_1_1RCLTxSet_coll__map">
<area shape="rect" title="Represents a set of transactions in RCLConsensus." alt="" coords="2125,80,2253,105"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="1865,73,2036,113"/>
<area shape="poly" title=" " alt="" coords="2050,90,2125,90,2125,95,2050,95"/>
<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="1672,80,1795,105"/>
<area shape="poly" title=" " alt="" coords="1809,90,1865,90,1865,95,1809,95"/>
<area shape="rect" href="classripple_1_1Family.html" title=" " alt="" coords="1405,5,1515,31"/>
<area shape="poly" title=" " alt="" coords="1529,28,1649,58,1703,77,1701,82,1647,63,1528,34"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="1405,55,1515,80"/>
<area shape="poly" title=" " alt="" coords="1529,71,1672,84,1672,90,1529,76"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="1089,55,1235,80"/>
<area shape="poly" title=" " alt="" coords="1249,65,1404,65,1404,70,1249,70"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,365,108,391"/>
<area shape="poly" title=" " alt="" coords="64,351,89,295,108,263,130,234,174,184,214,147,235,133,260,123,289,117,323,115,1461,115,1573,110,1672,99,1672,104,1574,115,1461,121,323,121,290,123,261,128,238,138,217,151,178,187,134,237,112,266,94,297,69,354"/>
<area shape="rect" href="classripple_1_1SHAMapTreeNode.html" title=" " alt="" coords="1071,237,1253,263"/>
<area shape="poly" title=" " alt="" coords="72,352,110,302,168,245,202,218,240,197,280,182,323,177,904,177,970,183,1034,198,1091,217,1134,235,1132,240,1089,222,1033,203,969,188,904,182,324,182,282,187,242,202,205,223,171,249,114,306,76,355"/>
<area shape="rect" href="structripple_1_1IntrusiveRefCounts.html" title="Implement the strong count, weak count, and bit flags for an intrusive pointer." alt="" coords="544,365,735,391"/>
<area shape="poly" title=" " alt="" coords="122,375,544,375,544,381,122,381"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="221,427,428,452"/>
<area shape="poly" title=" " alt="" coords="95,394,133,409,221,427,220,432,131,414,93,399"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="241,477,409,517"/>
<area shape="poly" title=" " alt="" coords="79,399,104,423,133,444,186,466,241,481,240,486,185,471,131,448,100,427,76,403"/>
<area shape="rect" href="classripple_1_1SharedIntrusive.html" title=" " alt="" coords="1353,169,1567,209"/>
<area shape="poly" title=" " alt="" coords="1579,170,1647,149,1685,127,1716,103,1719,108,1688,131,1649,154,1581,175"/>
<area shape="poly" title=" " alt="" coords="1237,232,1362,206,1363,211,1239,237"/>
<area shape="poly" title=" " alt="" coords="699,359,1003,281,1097,260,1098,265,1005,286,701,364"/>
<area shape="poly" title=" " alt="" coords="441,423,519,409,597,388,599,393,521,414,442,428"/>
<area shape="rect" href="classripple_1_1SHAMapHash.html" title=" " alt="" coords="825,348,980,373"/>
<area shape="poly" title=" " alt="" coords="945,340,1130,260,1132,265,947,345"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="569,475,710,515"/>
<area shape="poly" title=" " alt="" coords="691,467,875,371,878,376,693,471"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="281,543,369,568"/>
<area shape="poly" title=" " alt="" coords="382,548,448,541,519,529,578,513,580,518,521,534,449,546,383,554"/>
<area shape="poly" title=" " alt="" coords="423,494,569,493,569,498,423,499"/>
</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">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLTxSet_1_1MutableTxSet.html">MutableTxSet</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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:a8dbf7a38f9f988c6da525b721c64019e" id="r_a8dbf7a38f9f988c6da525b721c64019e"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLTxSet.html#a8dbf7a38f9f988c6da525b721c64019e">ID</a> = <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a></td></tr>
<tr class="memdesc:a8dbf7a38f9f988c6da525b721c64019e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unique identifier/hash of the set of transactions. <br /></td></tr>
<tr class="separator:a8dbf7a38f9f988c6da525b721c64019e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b6da03b618a8963fc39f1a404a6d95d" id="r_a4b6da03b618a8963fc39f1a404a6d95d"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLTxSet.html#a4b6da03b618a8963fc39f1a404a6d95d">Tx</a> = <a class="el" href="classripple_1_1RCLCxTx.html">RCLCxTx</a></td></tr>
<tr class="memdesc:a4b6da03b618a8963fc39f1a404a6d95d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The type that corresponds to a single transaction. <br /></td></tr>
<tr class="separator:a4b6da03b618a8963fc39f1a404a6d95d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a59c6a813d4932ac8767c839452ffb759" id="r_a59c6a813d4932ac8767c839452ffb759"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLTxSet.html#a59c6a813d4932ac8767c839452ffb759">RCLTxSet</a> (<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; m)</td></tr>
<tr class="memdesc:a59c6a813d4932ac8767c839452ffb759"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a59c6a813d4932ac8767c839452ffb759"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a443cc4a968192db40a9aaa351809fced" id="r_a443cc4a968192db40a9aaa351809fced"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLTxSet.html#a443cc4a968192db40a9aaa351809fced">RCLTxSet</a> (<a class="el" href="classripple_1_1RCLTxSet_1_1MutableTxSet.html">MutableTxSet</a> const &amp;m)</td></tr>
<tr class="memdesc:a443cc4a968192db40a9aaa351809fced"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor from a previously created <a class="el" href="classripple_1_1RCLTxSet_1_1MutableTxSet.html">MutableTxSet</a>. <br /></td></tr>
<tr class="separator:a443cc4a968192db40a9aaa351809fced"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1aa1f8c61d05a23d608aa97701f25e8d" id="r_a1aa1f8c61d05a23d608aa97701f25e8d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLTxSet.html#a1aa1f8c61d05a23d608aa97701f25e8d">exists</a> (<a class="el" href="classripple_1_1RCLCxTx.html#af23a5fc53012f97206cc37602b3301ce">Tx::ID</a> const &amp;entry) const</td></tr>
<tr class="memdesc:a1aa1f8c61d05a23d608aa97701f25e8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if a transaction is in the set. <br /></td></tr>
<tr class="separator:a1aa1f8c61d05a23d608aa97701f25e8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6251c0b9121bbb093ca29b3f00dfb16b" id="r_a6251c0b9121bbb093ca29b3f00dfb16b"><td class="memItemLeft" align="right" valign="top">boost::intrusive_ptr&lt; <a class="el" href="classripple_1_1SHAMapItem.html">SHAMapItem</a> const &gt; const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLTxSet.html#a6251c0b9121bbb093ca29b3f00dfb16b">find</a> (<a class="el" href="classripple_1_1RCLCxTx.html#af23a5fc53012f97206cc37602b3301ce">Tx::ID</a> const &amp;entry) const</td></tr>
<tr class="memdesc:a6251c0b9121bbb093ca29b3f00dfb16b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lookup a transaction. <br /></td></tr>
<tr class="separator:a6251c0b9121bbb093ca29b3f00dfb16b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad31267724bea159c408fc622adef03c1" id="r_ad31267724bea159c408fc622adef03c1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1RCLTxSet.html#a8dbf7a38f9f988c6da525b721c64019e">ID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLTxSet.html#ad31267724bea159c408fc622adef03c1">id</a> () const</td></tr>
<tr class="memdesc:ad31267724bea159c408fc622adef03c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The unique ID/hash of the transaction set. <br /></td></tr>
<tr class="separator:ad31267724bea159c408fc622adef03c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1f1a3f904da003c6a75f34a52cabbf4" id="r_af1f1a3f904da003c6a75f34a52cabbf4"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/map.html">std::map</a>&lt; <a class="el" href="classripple_1_1RCLCxTx.html#af23a5fc53012f97206cc37602b3301ce">Tx::ID</a>, bool &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLTxSet.html#af1f1a3f904da003c6a75f34a52cabbf4">compare</a> (<a class="el" href="classripple_1_1RCLTxSet.html">RCLTxSet</a> const &amp;j) const</td></tr>
<tr class="memdesc:af1f1a3f904da003c6a75f34a52cabbf4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find transactions not in common between this and another transaction set. <br /></td></tr>
<tr class="separator:af1f1a3f904da003c6a75f34a52cabbf4"><td class="memSeparator" colspan="2">&#160;</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:af36354d58eaa7e9ea65500a213d9aea5" id="r_af36354d58eaa7e9ea65500a213d9aea5"><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.html#af36354d58eaa7e9ea65500a213d9aea5">map_</a></td></tr>
<tr class="memdesc:af36354d58eaa7e9ea65500a213d9aea5"><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. <br /></td></tr>
<tr class="separator:af36354d58eaa7e9ea65500a213d9aea5"><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>Represents a set of transactions 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_1RCLTxSet.html" title="Represents a set of transactions in RCLConsensus.">RCLTxSet</a> is a thin wrapper over a <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> that stores the set of transactions. </p>
<p class="definition">Definition at line <a class="el" href="RCLCxTx_8h_source.html#l00043">43</a> of file <a class="el" href="RCLCxTx_8h_source.html">RCLCxTx.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a8dbf7a38f9f988c6da525b721c64019e" name="a8dbf7a38f9f988c6da525b721c64019e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8dbf7a38f9f988c6da525b721c64019e">&#9670;&#160;</a></span>ID</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1RCLTxSet.html#a8dbf7a38f9f988c6da525b721c64019e">ripple::RCLTxSet::ID</a> = <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unique identifier/hash of the set of transactions. </p>
<p class="definition">Definition at line <a class="el" href="RCLCxTx_8h_source.html#l00047">47</a> of file <a class="el" href="RCLCxTx_8h_source.html">RCLCxTx.h</a>.</p>
</div>
</div>
<a id="a4b6da03b618a8963fc39f1a404a6d95d" name="a4b6da03b618a8963fc39f1a404a6d95d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b6da03b618a8963fc39f1a404a6d95d">&#9670;&#160;</a></span>Tx</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1RCLTxSet.html#a4b6da03b618a8963fc39f1a404a6d95d">ripple::RCLTxSet::Tx</a> = <a class="el" href="classripple_1_1RCLCxTx.html">RCLCxTx</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The type that corresponds to a single transaction. </p>
<p class="definition">Definition at line <a class="el" href="RCLCxTx_8h_source.html#l00049">49</a> of file <a class="el" href="RCLCxTx_8h_source.html">RCLCxTx.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a59c6a813d4932ac8767c839452ffb759" name="a59c6a813d4932ac8767c839452ffb759"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59c6a813d4932ac8767c839452ffb759">&#9670;&#160;</a></span>RCLTxSet() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::RCLTxSet::RCLTxSet </td>
<td>(</td>
<td class="paramtype"><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="paramname"><em>m</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">m</td><td><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> to wrap </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="RCLCxTx_8h_source.html#l00090">90</a> of file <a class="el" href="RCLCxTx_8h_source.html">RCLCxTx.h</a>.</p>
</div>
</div>
<a id="a443cc4a968192db40a9aaa351809fced" name="a443cc4a968192db40a9aaa351809fced"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a443cc4a968192db40a9aaa351809fced">&#9670;&#160;</a></span>RCLTxSet() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::RCLTxSet::RCLTxSet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1RCLTxSet_1_1MutableTxSet.html">MutableTxSet</a> const &amp;&#160;</td>
<td class="paramname"><em>m</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor from a previously created <a class="el" href="classripple_1_1RCLTxSet_1_1MutableTxSet.html">MutableTxSet</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">m</td><td><a class="el" href="classripple_1_1RCLTxSet_1_1MutableTxSet.html">MutableTxSet</a> that will become fixed </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="RCLCxTx_8h_source.html#l00100">100</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="a1aa1f8c61d05a23d608aa97701f25e8d" name="a1aa1f8c61d05a23d608aa97701f25e8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1aa1f8c61d05a23d608aa97701f25e8d">&#9670;&#160;</a></span>exists()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::RCLTxSet::exists </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> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Test if a transaction is in the set. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entry</td><td>The ID of transaction to test. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether the transaction is in the set. </dd></dl>
<p class="definition">Definition at line <a class="el" href="RCLCxTx_8h_source.html#l00110">110</a> of file <a class="el" href="RCLCxTx_8h_source.html">RCLCxTx.h</a>.</p>
</div>
</div>
<a id="a6251c0b9121bbb093ca29b3f00dfb16b" name="a6251c0b9121bbb093ca29b3f00dfb16b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6251c0b9121bbb093ca29b3f00dfb16b">&#9670;&#160;</a></span>find()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boost::intrusive_ptr&lt; <a class="el" href="classripple_1_1SHAMapItem.html">SHAMapItem</a> const &gt; const &amp; ripple::RCLTxSet::find </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> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Lookup a transaction. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entry</td><td>The ID of the transaction to find. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A shared pointer to the <a class="el" href="classripple_1_1SHAMapItem.html">SHAMapItem</a>.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Since find may not succeed, this returns a <code><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt;const <a class="el" href="classripple_1_1SHAMapItem.html">SHAMapItem</a>&gt;</code> rather than a Tx, which cannot refer to a missing transaction. The generic consensus code uses the shared_ptr semantics to know whether the find was successful and properly creates a Tx as needed. </dd></dl>
<p class="definition">Definition at line <a class="el" href="RCLCxTx_8h_source.html#l00127">127</a> of file <a class="el" href="RCLCxTx_8h_source.html">RCLCxTx.h</a>.</p>
</div>
</div>
<a id="ad31267724bea159c408fc622adef03c1" name="ad31267724bea159c408fc622adef03c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad31267724bea159c408fc622adef03c1">&#9670;&#160;</a></span>id()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1RCLTxSet.html#a8dbf7a38f9f988c6da525b721c64019e">ID</a> ripple::RCLTxSet::id </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>The unique ID/hash of the transaction set. </p>
<p class="definition">Definition at line <a class="el" href="RCLCxTx_8h_source.html#l00134">134</a> of file <a class="el" href="RCLCxTx_8h_source.html">RCLCxTx.h</a>.</p>
</div>
</div>
<a id="af1f1a3f904da003c6a75f34a52cabbf4" name="af1f1a3f904da003c6a75f34a52cabbf4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1f1a3f904da003c6a75f34a52cabbf4">&#9670;&#160;</a></span>compare()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/map.html">std::map</a>&lt; <a class="el" href="classripple_1_1RCLCxTx.html#af23a5fc53012f97206cc37602b3301ce">Tx::ID</a>, bool &gt; ripple::RCLTxSet::compare </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1RCLTxSet.html">RCLTxSet</a> const &amp;&#160;</td>
<td class="paramname"><em>j</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Find transactions not in common between this and another transaction set. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">j</td><td>The set to compare with </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Map of transactions in this set and <code>j</code> but not both. The key is the transaction ID and the value is a bool of the transaction exists in this set. </dd></dl>
<p class="definition">Definition at line <a class="el" href="RCLCxTx_8h_source.html#l00148">148</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="af36354d58eaa7e9ea65500a213d9aea5" name="af36354d58eaa7e9ea65500a213d9aea5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af36354d58eaa7e9ea65500a213d9aea5">&#9670;&#160;</a></span>map_</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>&lt;<a class="el" href="classripple_1_1SHAMap.html">SHAMap</a>&gt; ripple::RCLTxSet::map_</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#l00169">169</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="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink