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
4ad595bf180bbc8de37e3e4918f5d3183e8aae8c
rippled/structripple_1_1PreflightResult.html
nbougalis 4ad595bf18 deploy: 020b285808
2020-04-15 21:15:02 +00:00

344 lines
21 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::PreflightResult Struct 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="structripple_1_1PreflightResult.html">PreflightResult</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structripple_1_1PreflightResult-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::PreflightResult Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Describes the results of the <code>preflight</code> check.
<a href="structripple_1_1PreflightResult.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::PreflightResult:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1PreflightResult__coll__graph.png" border="0" usemap="#ripple_1_1PreflightResult_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1PreflightResult_coll__map" id="ripple_1_1PreflightResult_coll__map">
<area shape="rect" title="Describes the results of the preflight check." alt="" coords="2209,310,2371,337"/>
<area shape="rect" href="classripple_1_1TERSubset.html" title=" " alt="" coords="1977,217,2124,259"/>
<area shape="rect" href="classripple_1_1Rules.html" title="Rules controlling protocol behavior." alt="" coords="1999,346,2102,373"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="1707,339,1877,380"/>
<area shape="rect" href="classripple_1_1Rules_1_1Impl.html" title=" " alt="" coords="1485,394,1624,421"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/unordered_set.html" title=" " alt="" coords="1159,379,1365,435"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="892,424,1033,465"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/unordered_set.html" title=" " alt="" coords="1187,459,1337,515"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="605,437,773,479"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="892,321,1033,363"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="293,445,396,471"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="645,293,733,319"/>
<area shape="rect" href="classripple_1_1STTx.html" title=" " alt="" coords="1743,267,1841,294"/>
<area shape="rect" href="classripple_1_1detail_1_1STVar.html" title=" " alt="" coords="888,134,1037,161"/>
<area shape="rect" href="classripple_1_1STObject.html" title=" " alt="" coords="1492,159,1617,186"/>
<area shape="rect" href="classripple_1_1STBase.html" title="A type which can be exported to a well known binary format." alt="" coords="632,219,747,246"/>
<area shape="rect" href="classripple_1_1SField.html" title="Identifies fields." alt="" coords="292,174,397,201"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="611,153,767,195"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title="STL class." alt="" coords="28,149,115,175"/>
<area shape="rect" href="classJson_1_1StaticString.html" title="Lightweight wrapper to tag static string." alt="" coords="5,199,137,226"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="1181,5,1343,47"/>
<area shape="rect" href="classripple_1_1SOTemplate.html" title="Defines the fields and their attributes within a STObject." alt="" coords="1189,71,1335,98"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="893,13,1032,39"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="891,64,1034,105"/>
<area shape="rect" href="classripple_1_1SOElement.html" title="An element in a SOTemplate." alt="" coords="620,37,759,63"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/utility/functional/reference_wrapper.html" title=" " alt="" coords="257,29,432,71"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="1191,123,1333,164"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/aligned_storage.html" title=" " alt="" coords="612,88,767,129"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="1473,93,1636,135"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="1995,401,2106,427"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="1719,405,1865,431"/>
</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:a3804e7a9e9cfd06b09571edc3d489f24"><td class="memTemplParams" colspan="2">template&lt;class Context &gt; </td></tr>
<tr class="memitem:a3804e7a9e9cfd06b09571edc3d489f24"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structripple_1_1PreflightResult.html#a3804e7a9e9cfd06b09571edc3d489f24">PreflightResult</a> (Context const &amp;ctx_, <a class="el" href="namespaceripple.html#af99ba2263d2a1e29207c40a35fc9f6b3">NotTEC</a> ter_)</td></tr>
<tr class="memdesc:a3804e7a9e9cfd06b09571edc3d489f24"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="structripple_1_1PreflightResult.html#a3804e7a9e9cfd06b09571edc3d489f24">More...</a><br /></td></tr>
<tr class="separator:a3804e7a9e9cfd06b09571edc3d489f24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58eb0d239031ed4fb33b22f10c729e64"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreflightResult.html#a58eb0d239031ed4fb33b22f10c729e64">PreflightResult</a> (<a class="el" href="structripple_1_1PreflightResult.html">PreflightResult</a> const &amp;)=default</td></tr>
<tr class="separator:a58eb0d239031ed4fb33b22f10c729e64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0262ecf5f04e2439ffd5dac95d996ac7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1PreflightResult.html">PreflightResult</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreflightResult.html#a0262ecf5f04e2439ffd5dac95d996ac7">operator=</a> (<a class="el" href="structripple_1_1PreflightResult.html">PreflightResult</a> const &amp;)=delete</td></tr>
<tr class="memdesc:a0262ecf5f04e2439ffd5dac95d996ac7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deleted copy assignment operator. <a href="structripple_1_1PreflightResult.html#a0262ecf5f04e2439ffd5dac95d996ac7">More...</a><br /></td></tr>
<tr class="separator:a0262ecf5f04e2439ffd5dac95d996ac7"><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:afc32faa89017861a7dc93dffa72946fb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1STTx.html">STTx</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreflightResult.html#afc32faa89017861a7dc93dffa72946fb">tx</a></td></tr>
<tr class="memdesc:afc32faa89017861a7dc93dffa72946fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">From the input - the transaction. <a href="structripple_1_1PreflightResult.html#afc32faa89017861a7dc93dffa72946fb">More...</a><br /></td></tr>
<tr class="separator:afc32faa89017861a7dc93dffa72946fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4b697f3fa00d5bb98458f73eb8537ab"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classripple_1_1Rules.html">Rules</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreflightResult.html#ae4b697f3fa00d5bb98458f73eb8537ab">rules</a></td></tr>
<tr class="memdesc:ae4b697f3fa00d5bb98458f73eb8537ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">From the input - the rules. <a href="structripple_1_1PreflightResult.html#ae4b697f3fa00d5bb98458f73eb8537ab">More...</a><br /></td></tr>
<tr class="separator:ae4b697f3fa00d5bb98458f73eb8537ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac40d824df32b44d0a401442242333185"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ApplyFlags</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreflightResult.html#ac40d824df32b44d0a401442242333185">flags</a></td></tr>
<tr class="memdesc:ac40d824df32b44d0a401442242333185"><td class="mdescLeft">&#160;</td><td class="mdescRight">From the input - the flags. <a href="structripple_1_1PreflightResult.html#ac40d824df32b44d0a401442242333185">More...</a><br /></td></tr>
<tr class="separator:ac40d824df32b44d0a401442242333185"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84fdf3ccfe5fbeeee40fbb0217cd6cac"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreflightResult.html#a84fdf3ccfe5fbeeee40fbb0217cd6cac">j</a></td></tr>
<tr class="memdesc:a84fdf3ccfe5fbeeee40fbb0217cd6cac"><td class="mdescLeft">&#160;</td><td class="mdescRight">From the input - the journal. <a href="structripple_1_1PreflightResult.html#a84fdf3ccfe5fbeeee40fbb0217cd6cac">More...</a><br /></td></tr>
<tr class="separator:a84fdf3ccfe5fbeeee40fbb0217cd6cac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ff883db027bca4c1f3db9b6cf2efef1"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespaceripple.html#af99ba2263d2a1e29207c40a35fc9f6b3">NotTEC</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreflightResult.html#a6ff883db027bca4c1f3db9b6cf2efef1">ter</a></td></tr>
<tr class="memdesc:a6ff883db027bca4c1f3db9b6cf2efef1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Intermediate transaction result. <a href="structripple_1_1PreflightResult.html#a6ff883db027bca4c1f3db9b6cf2efef1">More...</a><br /></td></tr>
<tr class="separator:a6ff883db027bca4c1f3db9b6cf2efef1"><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>Describes the results of the <code>preflight</code> check. </p>
<dl class="section note"><dt>Note</dt><dd>All members are const to make it more difficult to "fake" a result without calling <code>preflight</code>. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceripple.html#a24280b80536d1afd09e24a75f4596922" title="Gate a transaction based on static information.">preflight</a>, <a class="el" href="namespaceripple.html#a5027a5209e954b9478fab70357963466" title="Gate a transaction based on static ledger information.">preclaim</a>, <a class="el" href="namespaceripple.html#a305632c3ccdbb4005fa2b019c51b5ac1" title="Apply a prechecked transaction to an OpenView.">doApply</a>, <a class="el" href="namespaceripple.html#a19f506b57882e3396d15d7c43fa92d92" title="Apply a transaction to an OpenView.">apply</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00047">47</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3804e7a9e9cfd06b09571edc3d489f24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3804e7a9e9cfd06b09571edc3d489f24">&#9670;&nbsp;</a></span>PreflightResult() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Context &gt; </div>
<table class="memname">
<tr>
<td class="memname">ripple::PreflightResult::PreflightResult </td>
<td>(</td>
<td class="paramtype">Context const &amp;&#160;</td>
<td class="paramname"><em>ctx_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#af99ba2263d2a1e29207c40a35fc9f6b3">NotTEC</a>&#160;</td>
<td class="paramname"><em>ter_</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00064">64</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<a id="a58eb0d239031ed4fb33b22f10c729e64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58eb0d239031ed4fb33b22f10c729e64">&#9670;&nbsp;</a></span>PreflightResult() <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">ripple::PreflightResult::PreflightResult </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1PreflightResult.html">PreflightResult</a> const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a0262ecf5f04e2439ffd5dac95d996ac7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0262ecf5f04e2439ffd5dac95d996ac7">&#9670;&nbsp;</a></span>operator=()</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="structripple_1_1PreflightResult.html">PreflightResult</a>&amp; ripple::PreflightResult::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1PreflightResult.html">PreflightResult</a> const &amp;&#160;</td>
<td class="paramname"></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">
<p>Deleted copy assignment operator. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="afc32faa89017861a7dc93dffa72946fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc32faa89017861a7dc93dffa72946fb">&#9670;&nbsp;</a></span>tx</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1STTx.html">STTx</a> const&amp; ripple::PreflightResult::tx</td>
</tr>
</table>
</div><div class="memdoc">
<p>From the input - the transaction. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00051">51</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<a id="ae4b697f3fa00d5bb98458f73eb8537ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4b697f3fa00d5bb98458f73eb8537ab">&#9670;&nbsp;</a></span>rules</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classripple_1_1Rules.html">Rules</a> ripple::PreflightResult::rules</td>
</tr>
</table>
</div><div class="memdoc">
<p>From the input - the rules. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00053">53</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<a id="ac40d824df32b44d0a401442242333185"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac40d824df32b44d0a401442242333185">&#9670;&nbsp;</a></span>flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ApplyFlags</a> ripple::PreflightResult::flags</td>
</tr>
</table>
</div><div class="memdoc">
<p>From the input - the flags. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00055">55</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<a id="a84fdf3ccfe5fbeeee40fbb0217cd6cac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84fdf3ccfe5fbeeee40fbb0217cd6cac">&#9670;&nbsp;</a></span>j</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> ripple::PreflightResult::j</td>
</tr>
</table>
</div><div class="memdoc">
<p>From the input - the journal. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00057">57</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.h</a>.</p>
</div>
</div>
<a id="a6ff883db027bca4c1f3db9b6cf2efef1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ff883db027bca4c1f3db9b6cf2efef1">&#9670;&nbsp;</a></span>ter</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="namespaceripple.html#af99ba2263d2a1e29207c40a35fc9f6b3">NotTEC</a> ripple::PreflightResult::ter</td>
</tr>
</table>
</div><div class="memdoc">
<p>Intermediate transaction result. </p>
<p class="definition">Definition at line <a class="el" href="applySteps_8h_source.html#l00060">60</a> of file <a class="el" href="applySteps_8h_source.html">applySteps.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