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
6e4b4ad064564d5fe2e166d04d113d603ddab3f9
rippled/structripple_1_1PreclaimContext.html
manojsdoshi 9aeea1cf29 deploy: 670bc22cfa
2022-05-11 23:57:28 +00:00

339 lines
20 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::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 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_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>
<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="#ripple_1_1PreclaimContext_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1PreclaimContext_coll__map" id="ripple_1_1PreclaimContext_coll__map">
<area shape="rect" title="State information when determining if a tx is likely to claim a fee." alt="" coords="2143,411,2318,437"/>
<area shape="rect" href="classripple_1_1Application.html" title=" " alt="" coords="1685,177,1825,204"/>
<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="1209,95,1377,137"/>
<area shape="rect" href="classbeast_1_1PropertyStream_1_1Item.html" title=" " alt="" coords="1493,50,1661,91"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html" title="STL class." alt="" coords="916,41,1075,68"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title="STL class." alt="" coords="28,107,115,133"/>
<area shape="rect" href="classripple_1_1SField.html" title="Identifies fields." alt="" coords="292,155,397,181"/>
<area shape="rect" href="classbeast_1_1List.html" title=" " alt="" coords="903,154,1088,195"/>
<area shape="rect" href="classbeast_1_1detail_1_1ListNode.html" title=" " alt="" coords="605,220,788,276"/>
<area shape="rect" href="classbeast_1_1detail_1_1ListNode.html" title=" " alt="" coords="261,259,429,301"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="653,300,741,327"/>
<area shape="rect" href="classripple_1_1STTx.html" title=" " alt="" coords="1873,411,1972,437"/>
<area shape="rect" href="classripple_1_1detail_1_1STVar.html" title=" " alt="" coords="921,477,1070,504"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="925,338,1066,379"/>
<area shape="rect" title=" " alt="" coords="1220,5,1367,32"/>
<area shape="rect" href="classripple_1_1STObject.html" title=" " alt="" coords="1515,423,1640,449"/>
<area shape="rect" href="classripple_1_1STBase.html" title="A type which can be exported to a well known binary format." alt="" coords="639,435,754,461"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="619,154,775,195"/>
<area shape="rect" href="classJson_1_1StaticString.html" title="Lightweight wrapper to tag static string." alt="" coords="5,172,137,199"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="1212,539,1375,581"/>
<area shape="rect" href="classripple_1_1SOTemplate.html" title="Defines the fields and their attributes within a STObject." alt="" coords="1221,605,1366,632"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="926,579,1065,605"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="924,630,1067,671"/>
<area shape="rect" href="classripple_1_1SOElement.html" title="An element in a SOTemplate." alt="" coords="627,637,766,664"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/utility/functional/reference_wrapper.html" title=" " alt="" coords="257,630,432,671"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="1222,474,1365,515"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/aligned_storage.html" title=" " alt="" coords="619,507,774,549"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="1496,474,1659,515"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="613,351,781,393"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="293,359,396,385"/>
<area shape="rect" href="classripple_1_1ReadView.html" title="A view into a ledger." alt="" coords="1857,211,1988,237"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="2143,123,2319,179"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="2143,203,2319,245"/>
<area shape="rect" href="structripple_1_1ReadView_1_1sles__type.html" title=" " alt="" coords="2368,89,2568,116"/>
<area shape="rect" href="structripple_1_1ReadView_1_1txs__type.html" title=" " alt="" coords="2371,253,2565,280"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="1867,532,1978,559"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="1504,540,1651,567"/>
<area shape="rect" href="classripple_1_1TERSubset.html" title=" " alt="" coords="1849,462,1996,503"/>
</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: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:ab57a71f0087817052d2a1e962aa61f94"><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#ab57a71f0087817052d2a1e962aa61f94">operator=</a> (<a class="el" href="structripple_1_1PreclaimContext.html">PreclaimContext</a> const &amp;)=delete</td></tr>
<tr class="separator:ab57a71f0087817052d2a1e962aa61f94"><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: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:a534551c8ca0dd7afc8fe9098bf9da780"><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_1PreclaimContext.html#a534551c8ca0dd7afc8fe9098bf9da780">j</a></td></tr>
<tr class="separator:a534551c8ca0dd7afc8fe9098bf9da780"><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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a346b534152c02f6244299306a3f32b18">&#9670;&nbsp;</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="ab57a71f0087817052d2a1e962aa61f94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab57a71f0087817052d2a1e962aa61f94">&#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_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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac708cdcba9aeaf51a302b30311912617">&#9670;&nbsp;</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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05d5cf6207c1127c25dcd7c3f763b9c5">&#9670;&nbsp;</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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf5e0b3ff3e3e42a59b37ae68e20feba">&#9670;&nbsp;</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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e1240b39791cf309b9caaffe8e5d306">&#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::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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa040bf08a657fdb70f8b8764f94e8688">&#9670;&nbsp;</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="a534551c8ca0dd7afc8fe9098bf9da780"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a534551c8ca0dd7afc8fe9098bf9da780">&#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::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="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