Files
rippled/classripple_1_1RCLCxTx.html
2025-01-21 19:58:08 +00:00

212 lines
12 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::RCLCxTx Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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_1RCLCxTx.html">RCLCxTx</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<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_1RCLCxTx-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::RCLCxTx Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Represents a transaction 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_1RCLCxTx.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="RCLCxTx_8h_source.html">RCLCxTx.h</a>&gt;</code></p>
<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:af23a5fc53012f97206cc37602b3301ce"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxTx.html#af23a5fc53012f97206cc37602b3301ce">ID</a> = <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a></td></tr>
<tr class="memdesc:af23a5fc53012f97206cc37602b3301ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unique identifier/hash of transaction. <a href="classripple_1_1RCLCxTx.html#af23a5fc53012f97206cc37602b3301ce">More...</a><br /></td></tr>
<tr class="separator:af23a5fc53012f97206cc37602b3301ce"><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:a414a40b4730525c49fd72ad4d3e6a76e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxTx.html#a414a40b4730525c49fd72ad4d3e6a76e">RCLCxTx</a> (boost::intrusive_ptr&lt; <a class="el" href="classripple_1_1SHAMapItem.html">SHAMapItem</a> const &gt; txn)</td></tr>
<tr class="memdesc:a414a40b4730525c49fd72ad4d3e6a76e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="classripple_1_1RCLCxTx.html#a414a40b4730525c49fd72ad4d3e6a76e">More...</a><br /></td></tr>
<tr class="separator:a414a40b4730525c49fd72ad4d3e6a76e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f9b3c275aeb181e183c4b4b2a21f034"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1RCLCxTx.html#af23a5fc53012f97206cc37602b3301ce">ID</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxTx.html#a1f9b3c275aeb181e183c4b4b2a21f034">id</a> () const</td></tr>
<tr class="memdesc:a1f9b3c275aeb181e183c4b4b2a21f034"><td class="mdescLeft">&#160;</td><td class="mdescRight">The unique identifier/hash of the transaction. <a href="classripple_1_1RCLCxTx.html#a1f9b3c275aeb181e183c4b4b2a21f034">More...</a><br /></td></tr>
<tr class="separator:a1f9b3c275aeb181e183c4b4b2a21f034"><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:ad18aaac4c2cedb3c620489a9b055d2b7"><td class="memItemLeft" align="right" valign="top">boost::intrusive_ptr&lt; <a class="el" href="classripple_1_1SHAMapItem.html">SHAMapItem</a> const &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RCLCxTx.html#ad18aaac4c2cedb3c620489a9b055d2b7">tx_</a></td></tr>
<tr class="memdesc:ad18aaac4c2cedb3c620489a9b055d2b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="classripple_1_1SHAMapItem.html">SHAMapItem</a> that represents the transaction. <a href="classripple_1_1RCLCxTx.html#ad18aaac4c2cedb3c620489a9b055d2b7">More...</a><br /></td></tr>
<tr class="separator:ad18aaac4c2cedb3c620489a9b055d2b7"><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 transaction 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_1RCLCxTx.html" title="Represents a transaction in RCLConsensus.">RCLCxTx</a> is a thin wrapper over the <a class="el" href="classripple_1_1SHAMapItem.html">SHAMapItem</a> that corresponds to the transaction. </p>
<p class="definition">Definition at line <a class="el" href="RCLCxTx_8h_source.html#l00035">35</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="af23a5fc53012f97206cc37602b3301ce" name="af23a5fc53012f97206cc37602b3301ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af23a5fc53012f97206cc37602b3301ce">&#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_1RCLCxTx.html#af23a5fc53012f97206cc37602b3301ce">ripple::RCLCxTx::ID</a> = <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unique identifier/hash of transaction. </p>
<p class="definition">Definition at line <a class="el" href="RCLCxTx_8h_source.html#l00039">39</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="a414a40b4730525c49fd72ad4d3e6a76e" name="a414a40b4730525c49fd72ad4d3e6a76e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a414a40b4730525c49fd72ad4d3e6a76e">&#9670;&#160;</a></span>RCLCxTx()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::RCLCxTx::RCLCxTx </td>
<td>(</td>
<td class="paramtype">boost::intrusive_ptr&lt; <a class="el" href="classripple_1_1SHAMapItem.html">SHAMapItem</a> const &gt;&#160;</td>
<td class="paramname"><em>txn</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">txn</td><td>The transaction to wrap </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="RCLCxTx_8h_source.html#l00045">45</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="a1f9b3c275aeb181e183c4b4b2a21f034" name="a1f9b3c275aeb181e183c4b4b2a21f034"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f9b3c275aeb181e183c4b4b2a21f034">&#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_1RCLCxTx.html#af23a5fc53012f97206cc37602b3301ce">ID</a> const &amp; ripple::RCLCxTx::id </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>The unique identifier/hash of the transaction. </p>
<p class="definition">Definition at line <a class="el" href="RCLCxTx_8h_source.html#l00051">51</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="ad18aaac4c2cedb3c620489a9b055d2b7" name="ad18aaac4c2cedb3c620489a9b055d2b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad18aaac4c2cedb3c620489a9b055d2b7">&#9670;&#160;</a></span>tx_</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; ripple::RCLCxTx::tx_</td>
</tr>
</table>
</div><div class="memdoc">
<p>The <a class="el" href="classripple_1_1SHAMapItem.html">SHAMapItem</a> that represents the transaction. </p>
<p class="definition">Definition at line <a class="el" href="RCLCxTx_8h_source.html#l00057">57</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.5
</small></address>
</body>
</html>