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

347 lines
21 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::PreclaimContext 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_1PreclaimContext.html">PreclaimContext</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_1PreclaimContext-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::PreclaimContext Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>State information when determining if a tx is likely to claim a fee.
<a href="structripple_1_1PreclaimContext.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::PreclaimContext:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1PreclaimContext__coll__graph.png" border="0" usemap="#aripple_1_1PreclaimContext_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1PreclaimContext_coll__map" id="aripple_1_1PreclaimContext_coll__map">
<area shape="rect" title="State information when determining if a tx is likely to claim a fee." alt="" coords="2338,337,2513,363"/>
<area shape="rect" href="classripple_1_1Application.html" title=" " alt="" coords="1873,504,2013,529"/>
<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="1397,515,1565,555"/>
<area shape="rect" href="classbeast_1_1PropertyStream_1_1Item.html" title=" " alt="" coords="1681,482,1849,522"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="216,392,303,417"/>
<area shape="rect" href="classripple_1_1SField.html" title="Identifies fields." alt="" coords="479,169,586,195"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="5,385,144,425"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html" title=" " alt="" coords="1104,523,1263,548"/>
<area shape="rect" title=" " alt="" coords="1408,427,1555,452"/>
<area shape="rect" href="classbeast_1_1List.html" title=" " alt="" coords="1091,458,1276,498"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="841,324,929,349"/>
<area shape="rect" href="classripple_1_1STTx.html" title=" " alt="" coords="2061,337,2160,363"/>
<area shape="rect" href="classripple_1_1detail_1_1STVar.html" title=" " alt="" coords="1109,209,1258,235"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="1113,361,1254,401"/>
<area shape="rect" href="classbeast_1_1detail_1_1ListNode.html" title=" " alt="" coords="793,492,976,547"/>
<area shape="rect" href="classbeast_1_1detail_1_1ListNode.html" title=" " alt="" coords="449,503,617,543"/>
<area shape="rect" href="classripple_1_1ReadView.html" title="A view into a ledger." alt="" coords="2045,536,2177,561"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="2332,529,2519,569"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="2337,655,2514,695"/>
<area shape="rect" href="structripple_1_1ReadView_1_1sles__type.html" title=" " alt="" coords="2568,493,2769,519"/>
<area shape="rect" href="structripple_1_1ReadView_1_1txs__type.html" title=" " alt="" coords="2571,611,2766,636"/>
<area shape="rect" href="classripple_1_1TERSubset.html" title=" " alt="" coords="2037,223,2184,263"/>
<area shape="rect" href="classripple_1_1STObject.html" title=" " alt="" coords="1703,221,1828,247"/>
<area shape="rect" href="classripple_1_1STBase.html" title="A type which can be exported to a well known binary format." alt="" coords="827,164,942,189"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="807,99,963,139"/>
<area shape="rect" href="classJson_1_1StaticString.html" title="Lightweight wrapper to tag static string." alt="" coords="193,169,325,195"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="1400,241,1563,281"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="1410,177,1553,217"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/aligned_storage.html" title=" " alt="" coords="807,214,962,254"/>
<area shape="rect" href="classripple_1_1SOTemplate.html" title="Defines the fields and their attributes within a STObject." alt="" coords="1409,63,1554,88"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="1112,55,1255,95"/>
<area shape="rect" href="classripple_1_1SOElement.html" title="An element in a SOTemplate." alt="" coords="815,49,954,75"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/functional/reference_wrapper.html" title=" " alt="" coords="445,42,620,82"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="1114,5,1253,31"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="1684,418,1847,458"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="801,393,969,433"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="481,400,584,425"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="2055,288,2166,313"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="1692,172,1839,197"/>
</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:a346b534152c02f6244299306a3f32b18"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreclaimContext.html#a346b534152c02f6244299306a3f32b18">PreclaimContext</a> (<a class="el" href="classripple_1_1Application.html">Application</a> &amp;app_, <a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &amp;view_, <a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> preflightResult_, <a class="el" href="classripple_1_1STTx.html">STTx</a> const &amp;tx_, <a class="el" href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ApplyFlags</a> flags_, <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> j_=<a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>{<a class="el" href="classbeast_1_1Journal.html#a930d70ff72f71414fcd5b560610cefb6">beast::Journal::getNullSink</a>()})</td></tr>
<tr class="separator:a346b534152c02f6244299306a3f32b18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14d130661b74d63a1a2860aa1c5a4f62"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1PreclaimContext.html">PreclaimContext</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreclaimContext.html#a14d130661b74d63a1a2860aa1c5a4f62">operator=</a> (<a class="el" href="structripple_1_1PreclaimContext.html">PreclaimContext</a> const &amp;)=delete</td></tr>
<tr class="separator:a14d130661b74d63a1a2860aa1c5a4f62"><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:ac708cdcba9aeaf51a302b30311912617"><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_1PreclaimContext.html#ac708cdcba9aeaf51a302b30311912617">app</a></td></tr>
<tr class="separator:ac708cdcba9aeaf51a302b30311912617"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05d5cf6207c1127c25dcd7c3f763b9c5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreclaimContext.html#a05d5cf6207c1127c25dcd7c3f763b9c5">view</a></td></tr>
<tr class="separator:a05d5cf6207c1127c25dcd7c3f763b9c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf5e0b3ff3e3e42a59b37ae68e20feba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1PreclaimContext.html#abf5e0b3ff3e3e42a59b37ae68e20feba">preflightResult</a></td></tr>
<tr class="separator:abf5e0b3ff3e3e42a59b37ae68e20feba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e1240b39791cf309b9caaffe8e5d306"><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_1PreclaimContext.html#a8e1240b39791cf309b9caaffe8e5d306">tx</a></td></tr>
<tr class="separator:a8e1240b39791cf309b9caaffe8e5d306"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa040bf08a657fdb70f8b8764f94e8688"><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_1PreclaimContext.html#aa040bf08a657fdb70f8b8764f94e8688">flags</a></td></tr>
<tr class="separator:aa040bf08a657fdb70f8b8764f94e8688"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb55565e34b187925992ba6c2f4a1d98"><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_1PreclaimContext.html#aeb55565e34b187925992ba6c2f4a1d98">j</a></td></tr>
<tr class="separator:aeb55565e34b187925992ba6c2f4a1d98"><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 determining if a tx is likely to claim a fee. </p>
<p class="definition">Definition at line <a class="el" href="Transactor_8h_source.html#l00052">52</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="a346b534152c02f6244299306a3f32b18" name="a346b534152c02f6244299306a3f32b18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a346b534152c02f6244299306a3f32b18">&#9670;&#160;</a></span>PreclaimContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::PreclaimContext::PreclaimContext </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_1ReadView.html">ReadView</a> const &amp;&#160;</td>
<td class="paramname"><em>view_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a>&#160;</td>
<td class="paramname"><em>preflightResult_</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="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> = <code><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>{<a class="el" href="classbeast_1_1Journal.html#a930d70ff72f71414fcd5b560610cefb6">beast::Journal::getNullSink</a>()}</code>&#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_8h_source.html#l00062">62</a> of file <a class="el" href="Transactor_8h_source.html">Transactor.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a14d130661b74d63a1a2860aa1c5a4f62" name="a14d130661b74d63a1a2860aa1c5a4f62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14d130661b74d63a1a2860aa1c5a4f62">&#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_1PreclaimContext.html">PreclaimContext</a> &amp; ripple::PreclaimContext::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1PreclaimContext.html">PreclaimContext</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="ac708cdcba9aeaf51a302b30311912617" name="ac708cdcba9aeaf51a302b30311912617"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac708cdcba9aeaf51a302b30311912617">&#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::PreclaimContext::app</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Transactor_8h_source.html#l00055">55</a> of file <a class="el" href="Transactor_8h_source.html">Transactor.h</a>.</p>
</div>
</div>
<a id="a05d5cf6207c1127c25dcd7c3f763b9c5" name="a05d5cf6207c1127c25dcd7c3f763b9c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05d5cf6207c1127c25dcd7c3f763b9c5">&#9670;&#160;</a></span>view</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1ReadView.html">ReadView</a> const&amp; ripple::PreclaimContext::view</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Transactor_8h_source.html#l00056">56</a> of file <a class="el" href="Transactor_8h_source.html">Transactor.h</a>.</p>
</div>
</div>
<a id="abf5e0b3ff3e3e42a59b37ae68e20feba" name="abf5e0b3ff3e3e42a59b37ae68e20feba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf5e0b3ff3e3e42a59b37ae68e20feba">&#9670;&#160;</a></span>preflightResult</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#adfb760bc3e4ccb79d5d4f6ecff2f1817">TER</a> ripple::PreclaimContext::preflightResult</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Transactor_8h_source.html#l00057">57</a> of file <a class="el" href="Transactor_8h_source.html">Transactor.h</a>.</p>
</div>
</div>
<a id="a8e1240b39791cf309b9caaffe8e5d306" name="a8e1240b39791cf309b9caaffe8e5d306"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e1240b39791cf309b9caaffe8e5d306">&#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::PreclaimContext::tx</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Transactor_8h_source.html#l00058">58</a> of file <a class="el" href="Transactor_8h_source.html">Transactor.h</a>.</p>
</div>
</div>
<a id="aa040bf08a657fdb70f8b8764f94e8688" name="aa040bf08a657fdb70f8b8764f94e8688"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa040bf08a657fdb70f8b8764f94e8688">&#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::PreclaimContext::flags</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Transactor_8h_source.html#l00059">59</a> of file <a class="el" href="Transactor_8h_source.html">Transactor.h</a>.</p>
</div>
</div>
<a id="aeb55565e34b187925992ba6c2f4a1d98" name="aeb55565e34b187925992ba6c2f4a1d98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb55565e34b187925992ba6c2f4a1d98">&#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::PreclaimContext::j</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Transactor_8h_source.html#l00060">60</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>