Files
rippled/structripple_1_1PreflightContext.html
2025-01-29 00:06:40 +00:00

324 lines
20 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::PreflightContext 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 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="structripple_1_1PreflightContext.html">PreflightContext</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_1PreflightContext-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::PreflightContext Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>State information when preflighting a tx.
<a href="structripple_1_1PreflightContext.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Transactor_8h_source.html">Transactor.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::PreflightContext:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1PreflightContext__coll__graph.png" border="0" usemap="#aripple_1_1PreflightContext_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1PreflightContext_coll__map" id="aripple_1_1PreflightContext_coll__map">
<area shape="rect" title="State information when preflighting a tx." alt="" coords="2543,464,2715,489"/>
<area shape="rect" href="classripple_1_1Application.html" title=" " alt="" coords="1912,252,2052,277"/>
<area shape="rect" href="classbeast_1_1PropertyStream_1_1Source.html" title="Subclasses can be called to write to a stream and have children." alt="" coords="1417,94,1585,134"/>
<area shape="rect" href="classbeast_1_1PropertyStream_1_1Item.html" title=" " alt="" coords="1720,49,1888,89"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="216,41,303,67"/>
<area shape="rect" href="classripple_1_1SField.html" title="Identifies fields." alt="" coords="479,91,586,116"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="5,34,144,74"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html" title=" " alt="" coords="1104,92,1263,117"/>
<area shape="rect" title=" " alt="" coords="1427,5,1574,31"/>
<area shape="rect" href="classbeast_1_1List.html" title=" " alt="" coords="1091,142,1276,182"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="841,469,929,495"/>
<area shape="rect" href="classripple_1_1STTx.html" title=" " alt="" coords="2112,439,2211,464"/>
<area shape="rect" href="classripple_1_1detail_1_1STVar.html" title=" " alt="" coords="1109,296,1258,321"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="1113,521,1254,561"/>
<area shape="rect" href="classripple_1_1base__uint.html" title="Integers of any length that is a multiple of 32&#45;bits." alt="" coords="1113,637,1254,677"/>
<area shape="rect" href="classbeast_1_1detail_1_1ListNode.html" title=" " alt="" coords="793,151,976,205"/>
<area shape="rect" href="classbeast_1_1detail_1_1ListNode.html" title=" " alt="" coords="449,194,617,234"/>
<area shape="rect" href="classripple_1_1STObject.html" title=" " alt="" coords="1741,352,1867,377"/>
<area shape="rect" href="classripple_1_1STBase.html" title="A type which can be exported to a well known binary format." alt="" coords="827,229,942,255"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="807,86,963,126"/>
<area shape="rect" href="classJson_1_1StaticString.html" title="Lightweight wrapper to tag static string." alt="" coords="193,105,325,131"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="1419,345,1582,385"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="1429,281,1572,321"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/aligned_storage.html" title=" " alt="" coords="807,325,962,365"/>
<area shape="rect" href="classripple_1_1SOTemplate.html" title="Defines the fields and their attributes within a STObject." alt="" coords="1428,409,1573,435"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="1112,402,1255,442"/>
<area shape="rect" href="classripple_1_1SOElement.html" title="An element in a SOTemplate." alt="" coords="815,420,954,445"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/functional/reference_wrapper.html" title=" " alt="" coords="445,413,620,453"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="1114,352,1253,377"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="1723,402,1885,442"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="801,606,969,646"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="481,613,584,639"/>
<area shape="rect" href="classripple_1_1Rules.html" title="Rules controlling protocol behavior." alt="" coords="2351,500,2453,525"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="2076,493,2247,533"/>
<area shape="rect" href="classripple_1_1Rules_1_1Impl.html" title=" " alt="" coords="1734,643,1874,668"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_set.html" title=" " alt="" coords="1397,579,1604,633"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/unordered_set.html" title=" " alt="" coords="1426,723,1575,777"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="1423,658,1578,698"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="2347,553,2457,579"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="2088,557,2235,583"/>
</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="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a90d5a33561e77a338eaf836fb516b64e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreflightContext.html#a90d5a33561e77a338eaf836fb516b64e">PreflightContext</a> (<a class="el" href="classripple_1_1Application.html">Application</a> &amp;app_, <a class="el" href="classripple_1_1STTx.html">STTx</a> const &amp;tx_, <a class="el" href="classripple_1_1Rules.html">Rules</a> const &amp;rules_, <a class="el" href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ApplyFlags</a> flags_, <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> j_)</td></tr>
<tr class="separator:a90d5a33561e77a338eaf836fb516b64e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af43fd1e983483bf86a9e2a3326e3806d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1PreflightContext.html">PreflightContext</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreflightContext.html#af43fd1e983483bf86a9e2a3326e3806d">operator=</a> (<a class="el" href="structripple_1_1PreflightContext.html">PreflightContext</a> const &amp;)=delete</td></tr>
<tr class="separator:af43fd1e983483bf86a9e2a3326e3806d"><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:a027e5fc872737a81a7d2428e6f251c1f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Application.html">Application</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreflightContext.html#a027e5fc872737a81a7d2428e6f251c1f">app</a></td></tr>
<tr class="separator:a027e5fc872737a81a7d2428e6f251c1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af202c00e509cfbb1df4fe69f4d6d6560"><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_1PreflightContext.html#af202c00e509cfbb1df4fe69f4d6d6560">tx</a></td></tr>
<tr class="separator:af202c00e509cfbb1df4fe69f4d6d6560"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab27bfce9ca08a7330ff573e4e2d5fc68"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Rules.html">Rules</a> const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreflightContext.html#ab27bfce9ca08a7330ff573e4e2d5fc68">rules</a></td></tr>
<tr class="separator:ab27bfce9ca08a7330ff573e4e2d5fc68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d3facd250e779742f64d8cc26739a10"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ApplyFlags</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreflightContext.html#a5d3facd250e779742f64d8cc26739a10">flags</a></td></tr>
<tr class="separator:a5d3facd250e779742f64d8cc26739a10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5e4a6c7a5f2acfe5a3c39a92cb86357"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreflightContext.html#ae5e4a6c7a5f2acfe5a3c39a92cb86357">j</a></td></tr>
<tr class="separator:ae5e4a6c7a5f2acfe5a3c39a92cb86357"><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 >State information when preflighting a tx. </p>
<p class="definition">Definition at line <a class="el" href="Transactor_8h_source.html#l00031">31</a> of file <a class="el" href="Transactor_8h_source.html">Transactor.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a90d5a33561e77a338eaf836fb516b64e" name="a90d5a33561e77a338eaf836fb516b64e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90d5a33561e77a338eaf836fb516b64e">&#9670;&#160;</a></span>PreflightContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::PreflightContext::PreflightContext </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Application.html">Application</a> &amp;&#160;</td>
<td class="paramname"><em>app_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1STTx.html">STTx</a> const &amp;&#160;</td>
<td class="paramname"><em>tx_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1Rules.html">Rules</a> const &amp;&#160;</td>
<td class="paramname"><em>rules_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ApplyFlags</a>&#160;</td>
<td class="paramname"><em>flags_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td>
<td class="paramname"><em>j_</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Transactor_8cpp_source.html#l00176">176</a> of file <a class="el" href="Transactor_8cpp_source.html">Transactor.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af43fd1e983483bf86a9e2a3326e3806d" name="af43fd1e983483bf86a9e2a3326e3806d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af43fd1e983483bf86a9e2a3326e3806d">&#9670;&#160;</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_1PreflightContext.html">PreflightContext</a> &amp; ripple::PreflightContext::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1PreflightContext.html">PreflightContext</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">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a027e5fc872737a81a7d2428e6f251c1f" name="a027e5fc872737a81a7d2428e6f251c1f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a027e5fc872737a81a7d2428e6f251c1f">&#9670;&#160;</a></span>app</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1Application.html">Application</a>&amp; ripple::PreflightContext::app</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Transactor_8h_source.html#l00034">34</a> of file <a class="el" href="Transactor_8h_source.html">Transactor.h</a>.</p>
</div>
</div>
<a id="af202c00e509cfbb1df4fe69f4d6d6560" name="af202c00e509cfbb1df4fe69f4d6d6560"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af202c00e509cfbb1df4fe69f4d6d6560">&#9670;&#160;</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::PreflightContext::tx</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Transactor_8h_source.html#l00035">35</a> of file <a class="el" href="Transactor_8h_source.html">Transactor.h</a>.</p>
</div>
</div>
<a id="ab27bfce9ca08a7330ff573e4e2d5fc68" name="ab27bfce9ca08a7330ff573e4e2d5fc68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab27bfce9ca08a7330ff573e4e2d5fc68">&#9670;&#160;</a></span>rules</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1Rules.html">Rules</a> const ripple::PreflightContext::rules</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Transactor_8h_source.html#l00036">36</a> of file <a class="el" href="Transactor_8h_source.html">Transactor.h</a>.</p>
</div>
</div>
<a id="a5d3facd250e779742f64d8cc26739a10" name="a5d3facd250e779742f64d8cc26739a10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d3facd250e779742f64d8cc26739a10">&#9670;&#160;</a></span>flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ApplyFlags</a> ripple::PreflightContext::flags</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Transactor_8h_source.html#l00037">37</a> of file <a class="el" href="Transactor_8h_source.html">Transactor.h</a>.</p>
</div>
</div>
<a id="ae5e4a6c7a5f2acfe5a3c39a92cb86357" name="ae5e4a6c7a5f2acfe5a3c39a92cb86357"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5e4a6c7a5f2acfe5a3c39a92cb86357">&#9670;&#160;</a></span>j</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const ripple::PreflightContext::j</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Transactor_8h_source.html#l00038">38</a> of file <a class="el" href="Transactor_8h_source.html">Transactor.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>