ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-06 17:27:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
3df04aee413816519feb9aa2ea6a34667fd2037b
rippled/classripple_1_1RCLTxSet.html
intelliot af6e9013ea deploy: c3acbce82d
2023-04-11 16:57:37 +00:00

380 lines
24 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<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 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> </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>
<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="#ripple_1_1RCLTxSet_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1RCLTxSet_coll__map" id="ripple_1_1RCLTxSet_coll__map">
<area shape="rect" title="Represents a set of transactions in RCLConsensus." alt="" coords="1975,111,2101,137"/>
<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="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 name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem: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. <a href="classripple_1_1RCLTxSet.html#a8dbf7a38f9f988c6da525b721c64019e">More...</a><br /></td></tr>
<tr class="separator:a8dbf7a38f9f988c6da525b721c64019e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem: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. <a href="classripple_1_1RCLTxSet.html#a4b6da03b618a8963fc39f1a404a6d95d">More...</a><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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem: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. <a href="classripple_1_1RCLTxSet.html#a59c6a813d4932ac8767c839452ffb759">More...</a><br /></td></tr>
<tr class="separator:a59c6a813d4932ac8767c839452ffb759"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem: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>. <a href="classripple_1_1RCLTxSet.html#a443cc4a968192db40a9aaa351809fced">More...</a><br /></td></tr>
<tr class="separator:a443cc4a968192db40a9aaa351809fced"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem: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. <a href="classripple_1_1RCLTxSet.html#a1aa1f8c61d05a23d608aa97701f25e8d">More...</a><br /></td></tr>
<tr class="separator:a1aa1f8c61d05a23d608aa97701f25e8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab426fc83d2f0045aef9e2e70b147a5ad"><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#ab426fc83d2f0045aef9e2e70b147a5ad">find</a> (<a class="el" href="classripple_1_1RCLCxTx.html#af23a5fc53012f97206cc37602b3301ce">Tx::ID</a> const &amp;entry) const</td></tr>
<tr class="memdesc:ab426fc83d2f0045aef9e2e70b147a5ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lookup a transaction. <a href="classripple_1_1RCLTxSet.html#ab426fc83d2f0045aef9e2e70b147a5ad">More...</a><br /></td></tr>
<tr class="separator:ab426fc83d2f0045aef9e2e70b147a5ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem: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. <a href="classripple_1_1RCLTxSet.html#ad31267724bea159c408fc622adef03c1">More...</a><br /></td></tr>
<tr class="separator:ad31267724bea159c408fc622adef03c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af04519658713359cf6e4cb1b35477529"><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#af04519658713359cf6e4cb1b35477529">compare</a> (<a class="el" href="classripple_1_1RCLTxSet.html">RCLTxSet</a> const &amp;j) const</td></tr>
<tr class="memdesc:af04519658713359cf6e4cb1b35477529"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find transactions not in common between this and another transaction set. <a href="classripple_1_1RCLTxSet.html#af04519658713359cf6e4cb1b35477529">More...</a><br /></td></tr>
<tr class="separator:af04519658713359cf6e4cb1b35477529"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem: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. <a href="classripple_1_1RCLTxSet.html#af36354d58eaa7e9ea65500a213d9aea5">More...</a><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#l00065">65</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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8dbf7a38f9f988c6da525b721c64019e">&#9670;&nbsp;</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#l00069">69</a> of file <a class="el" href="RCLCxTx_8h_source.html">RCLCxTx.h</a>.</p>
</div>
</div>
<a id="a4b6da03b618a8963fc39f1a404a6d95d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b6da03b618a8963fc39f1a404a6d95d">&#9670;&nbsp;</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#l00071">71</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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59c6a813d4932ac8767c839452ffb759">&#9670;&nbsp;</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#l00112">112</a> of file <a class="el" href="RCLCxTx_8h_source.html">RCLCxTx.h</a>.</p>
</div>
</div>
<a id="a443cc4a968192db40a9aaa351809fced"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a443cc4a968192db40a9aaa351809fced">&#9670;&nbsp;</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#l00121">121</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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1aa1f8c61d05a23d608aa97701f25e8d">&#9670;&nbsp;</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#l00131">131</a> of file <a class="el" href="RCLCxTx_8h_source.html">RCLCxTx.h</a>.</p>
</div>
</div>
<a id="ab426fc83d2f0045aef9e2e70b147a5ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab426fc83d2f0045aef9e2e70b147a5ad">&#9670;&nbsp;</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" title="STL class.">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#l00148">148</a> of file <a class="el" href="RCLCxTx_8h_source.html">RCLCxTx.h</a>.</p>
</div>
</div>
<a id="ad31267724bea159c408fc622adef03c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad31267724bea159c408fc622adef03c1">&#9670;&nbsp;</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#l00155">155</a> of file <a class="el" href="RCLCxTx_8h_source.html">RCLCxTx.h</a>.</p>
</div>
</div>
<a id="af04519658713359cf6e4cb1b35477529"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af04519658713359cf6e4cb1b35477529">&#9670;&nbsp;</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#l00169">169</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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af36354d58eaa7e9ea65500a213d9aea5">&#9670;&nbsp;</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#l00188">188</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>
Reference in New Issue View Git Blame Copy Permalink