Files
rippled/SetAccount_8h_source.html
2025-11-04 00:36:48 -08:00

159 lines
19 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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: SetAccount.h Source File</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.8 -->
<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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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="dir_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_c69db3203fa08a9ff994909ba6ee9783.html">app</a></li><li class="navelem"><a class="el" href="dir_4b2d6f306dc33741b6f38a59a670a446.html">tx</a></li><li class="navelem"><a class="el" href="dir_7b1ffcd2aae1e871efc2e94c72e78699.html">detail</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">SetAccount.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef XRPL_TX_SETACCOUNT_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_TX_SETACCOUNT_H_INCLUDED</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpld/app/tx/detail/Transactor.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;xrpl/protocol/TxFlags.h&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="foldopen" id="foldopen00010" data-start="{" data-end="};">
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="classripple_1_1SetAccount.html"> 10</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1SetAccount.html">SetAccount</a> : <span class="keyword">public</span> <a class="code hl_class" href="classripple_1_1Transactor.html">Transactor</a></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span>{</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="classripple_1_1SetAccount.html#aa7d1214ac532cbe36f3a3ff32a0a8ff2"> 13</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <a class="code hl_enumeration" href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938">ConsequencesFactoryType</a> <a class="code hl_variable" href="classripple_1_1SetAccount.html#aa7d1214ac532cbe36f3a3ff32a0a8ff2">ConsequencesFactory</a>{<a class="code hl_enumvalue" href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938a429832eac6b9ee7b50a1265131cd2845">Custom</a>};</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="foldopen" id="foldopen00015" data-start="{" data-end="}">
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="classripple_1_1SetAccount.html#ad206d7ebb116137621eaf5087c9137c4"> 15</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classripple_1_1SetAccount.html#ad206d7ebb116137621eaf5087c9137c4">SetAccount</a>(<a class="code hl_class" href="classripple_1_1ApplyContext.html">ApplyContext</a>&amp; ctx) : <a class="code hl_class" href="classripple_1_1Transactor.html">Transactor</a>(ctx)</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> {</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> }</div>
</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">static</span> <a class="code hl_class" href="classripple_1_1TxConsequences.html">TxConsequences</a></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_function" href="classripple_1_1SetAccount.html#abb06fa30fa778e448973d998ea192027">makeTxConsequences</a>(<a class="code hl_struct" href="structripple_1_1PreflightContext.html">PreflightContext</a> <span class="keyword">const</span>&amp; ctx);</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">static</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <a class="code hl_function" href="classripple_1_1SetAccount.html#aec1ce251e6e44244cb98cc831a25ae26">getFlagsMask</a>(<a class="code hl_struct" href="structripple_1_1PreflightContext.html">PreflightContext</a> <span class="keyword">const</span>&amp; ctx);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">static</span> <a class="code hl_class" href="classripple_1_1TERSubset.html">NotTEC</a></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <a class="code hl_function" href="classripple_1_1SetAccount.html#ac01c90c30283262f6ebb55c9026bdb5d">preflight</a>(<a class="code hl_struct" href="structripple_1_1PreflightContext.html">PreflightContext</a> <span class="keyword">const</span>&amp; ctx);</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">static</span> <a class="code hl_class" href="classripple_1_1TERSubset.html">NotTEC</a></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <a class="code hl_function" href="classripple_1_1SetAccount.html#a466a01edb97d0f37007bfb9d60084cb7">checkPermission</a>(<a class="code hl_class" href="classripple_1_1ReadView.html">ReadView</a> <span class="keyword">const</span>&amp; <a class="code hl_function" href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">view</a>, <a class="code hl_class" href="classripple_1_1STTx.html">STTx</a> <span class="keyword">const</span>&amp; tx);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">static</span> <a class="code hl_class" href="classripple_1_1TERSubset.html">TER</a></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <a class="code hl_function" href="classripple_1_1SetAccount.html#aa18fca61bcfa7624a172827de195a5e6">preclaim</a>(<a class="code hl_struct" href="structripple_1_1PreclaimContext.html">PreclaimContext</a> <span class="keyword">const</span>&amp; ctx);</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <a class="code hl_class" href="classripple_1_1TERSubset.html">TER</a></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <a class="code hl_function" href="classripple_1_1SetAccount.html#ac817ce99a0d2ac2ba879c15dbb8b6c3c">doApply</a>() <span class="keyword">override</span>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>};</div>
</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="namespaceripple.html#aadbea864f2a5f6e65c67d4f79f12bc66"> 38</a></span><span class="keyword">using </span><a class="code hl_class" href="classripple_1_1SetAccount.html">AccountSet</a> = <a class="code hl_class" href="classripple_1_1SetAccount.html">SetAccount</a>;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassripple_1_1ApplyContext_html"><div class="ttname"><a href="classripple_1_1ApplyContext.html">ripple::ApplyContext</a></div><div class="ttdoc">State information when applying a tx.</div><div class="ttdef"><b>Definition</b> <a href="ApplyContext_8h_source.html#l00017">ApplyContext.h:18</a></div></div>
<div class="ttc" id="aclassripple_1_1ReadView_html"><div class="ttname"><a href="classripple_1_1ReadView.html">ripple::ReadView</a></div><div class="ttdoc">A view into a ledger.</div><div class="ttdef"><b>Definition</b> <a href="ReadView_8h_source.html#l00031">ReadView.h:32</a></div></div>
<div class="ttc" id="aclassripple_1_1STTx_html"><div class="ttname"><a href="classripple_1_1STTx.html">ripple::STTx</a></div><div class="ttdef"><b>Definition</b> <a href="STTx_8h_source.html#l00028">STTx.h:29</a></div></div>
<div class="ttc" id="aclassripple_1_1SetAccount_html"><div class="ttname"><a href="classripple_1_1SetAccount.html">ripple::SetAccount</a></div><div class="ttdef"><b>Definition</b> <a href="SetAccount_8h_source.html#l00010">SetAccount.h:11</a></div></div>
<div class="ttc" id="aclassripple_1_1SetAccount_html_a466a01edb97d0f37007bfb9d60084cb7"><div class="ttname"><a href="classripple_1_1SetAccount.html#a466a01edb97d0f37007bfb9d60084cb7">ripple::SetAccount::checkPermission</a></div><div class="ttdeci">static NotTEC checkPermission(ReadView const &amp;view, STTx const &amp;tx)</div><div class="ttdef"><b>Definition</b> <a href="SetAccount_8cpp_source.html#l00168">SetAccount.cpp:168</a></div></div>
<div class="ttc" id="aclassripple_1_1SetAccount_html_aa18fca61bcfa7624a172827de195a5e6"><div class="ttname"><a href="classripple_1_1SetAccount.html#aa18fca61bcfa7624a172827de195a5e6">ripple::SetAccount::preclaim</a></div><div class="ttdeci">static TER preclaim(PreclaimContext const &amp;ctx)</div><div class="ttdef"><b>Definition</b> <a href="SetAccount_8cpp_source.html#l00223">SetAccount.cpp:223</a></div></div>
<div class="ttc" id="aclassripple_1_1SetAccount_html_aa7d1214ac532cbe36f3a3ff32a0a8ff2"><div class="ttname"><a href="classripple_1_1SetAccount.html#aa7d1214ac532cbe36f3a3ff32a0a8ff2">ripple::SetAccount::ConsequencesFactory</a></div><div class="ttdeci">static constexpr ConsequencesFactoryType ConsequencesFactory</div><div class="ttdef"><b>Definition</b> <a href="SetAccount_8h_source.html#l00013">SetAccount.h:13</a></div></div>
<div class="ttc" id="aclassripple_1_1SetAccount_html_abb06fa30fa778e448973d998ea192027"><div class="ttname"><a href="classripple_1_1SetAccount.html#abb06fa30fa778e448973d998ea192027">ripple::SetAccount::makeTxConsequences</a></div><div class="ttdeci">static TxConsequences makeTxConsequences(PreflightContext const &amp;ctx)</div><div class="ttdef"><b>Definition</b> <a href="SetAccount_8cpp_source.html#l00016">SetAccount.cpp:16</a></div></div>
<div class="ttc" id="aclassripple_1_1SetAccount_html_ac01c90c30283262f6ebb55c9026bdb5d"><div class="ttname"><a href="classripple_1_1SetAccount.html#ac01c90c30283262f6ebb55c9026bdb5d">ripple::SetAccount::preflight</a></div><div class="ttdeci">static NotTEC preflight(PreflightContext const &amp;ctx)</div><div class="ttdef"><b>Definition</b> <a href="SetAccount_8cpp_source.html#l00048">SetAccount.cpp:48</a></div></div>
<div class="ttc" id="aclassripple_1_1SetAccount_html_ac817ce99a0d2ac2ba879c15dbb8b6c3c"><div class="ttname"><a href="classripple_1_1SetAccount.html#ac817ce99a0d2ac2ba879c15dbb8b6c3c">ripple::SetAccount::doApply</a></div><div class="ttdeci">TER doApply() override</div><div class="ttdef"><b>Definition</b> <a href="SetAccount_8cpp_source.html#l00288">SetAccount.cpp:288</a></div></div>
<div class="ttc" id="aclassripple_1_1SetAccount_html_ad206d7ebb116137621eaf5087c9137c4"><div class="ttname"><a href="classripple_1_1SetAccount.html#ad206d7ebb116137621eaf5087c9137c4">ripple::SetAccount::SetAccount</a></div><div class="ttdeci">SetAccount(ApplyContext &amp;ctx)</div><div class="ttdef"><b>Definition</b> <a href="SetAccount_8h_source.html#l00015">SetAccount.h:15</a></div></div>
<div class="ttc" id="aclassripple_1_1SetAccount_html_aec1ce251e6e44244cb98cc831a25ae26"><div class="ttname"><a href="classripple_1_1SetAccount.html#aec1ce251e6e44244cb98cc831a25ae26">ripple::SetAccount::getFlagsMask</a></div><div class="ttdeci">static std::uint32_t getFlagsMask(PreflightContext const &amp;ctx)</div><div class="ttdef"><b>Definition</b> <a href="SetAccount_8cpp_source.html#l00042">SetAccount.cpp:42</a></div></div>
<div class="ttc" id="aclassripple_1_1TERSubset_html"><div class="ttname"><a href="classripple_1_1TERSubset.html">ripple::TERSubset</a></div><div class="ttdef"><b>Definition</b> <a href="TER_8h_source.html#l00395">TER.h:396</a></div></div>
<div class="ttc" id="aclassripple_1_1Transactor_html"><div class="ttname"><a href="classripple_1_1Transactor.html">ripple::Transactor</a></div><div class="ttdef"><b>Definition</b> <a href="Transactor_8h_source.html#l00121">Transactor.h:122</a></div></div>
<div class="ttc" id="aclassripple_1_1Transactor_html_a5c6d16e9402d182a835f50b37ce9a938"><div class="ttname"><a href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938">ripple::Transactor::ConsequencesFactoryType</a></div><div class="ttdeci">ConsequencesFactoryType</div><div class="ttdef"><b>Definition</b> <a href="Transactor_8h_source.html#l00138">Transactor.h:138</a></div></div>
<div class="ttc" id="aclassripple_1_1Transactor_html_a5c6d16e9402d182a835f50b37ce9a938a429832eac6b9ee7b50a1265131cd2845"><div class="ttname"><a href="classripple_1_1Transactor.html#a5c6d16e9402d182a835f50b37ce9a938a429832eac6b9ee7b50a1265131cd2845">ripple::Transactor::Custom</a></div><div class="ttdeci">@ Custom</div><div class="ttdef"><b>Definition</b> <a href="Transactor_8h_source.html#l00138">Transactor.h:138</a></div></div>
<div class="ttc" id="aclassripple_1_1Transactor_html_a9acc4edc9b8f2a11a27fbcf5e93e2fe2"><div class="ttname"><a href="classripple_1_1Transactor.html#a9acc4edc9b8f2a11a27fbcf5e93e2fe2">ripple::Transactor::view</a></div><div class="ttdeci">ApplyView &amp; view()</div><div class="ttdef"><b>Definition</b> <a href="Transactor_8h_source.html#l00144">Transactor.h:144</a></div></div>
<div class="ttc" id="aclassripple_1_1TxConsequences_html"><div class="ttname"><a href="classripple_1_1TxConsequences.html">ripple::TxConsequences</a></div><div class="ttdoc">Class describing the consequences to the account of applying a transaction if the transaction consume...</div><div class="ttdef"><b>Definition</b> <a href="applySteps_8h_source.html#l00038">applySteps.h:39</a></div></div>
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="astructripple_1_1PreclaimContext_html"><div class="ttname"><a href="structripple_1_1PreclaimContext.html">ripple::PreclaimContext</a></div><div class="ttdoc">State information when determining if a tx is likely to claim a fee.</div><div class="ttdef"><b>Definition</b> <a href="Transactor_8h_source.html#l00060">Transactor.h:61</a></div></div>
<div class="ttc" id="astructripple_1_1PreflightContext_html"><div class="ttname"><a href="structripple_1_1PreflightContext.html">ripple::PreflightContext</a></div><div class="ttdoc">State information when preflighting a tx.</div><div class="ttdef"><b>Definition</b> <a href="Transactor_8h_source.html#l00015">Transactor.h:16</a></div></div>
</div><!-- fragment --></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.8
</small></address>
</body>
</html>