Files
rippled/Sandbox_8h_source.html
2023-02-03 00:24:43 +00:00

154 lines
18 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">
<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: Sandbox.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 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="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_df67e75ba07853ef5c3c9d8f74c2f968.html">ledger</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Sandbox.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">//==============================================================================</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#ifndef RIPPLE_LEDGER_SANDBOX_H_INCLUDED</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define RIPPLE_LEDGER_SANDBOX_H_INCLUDED</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;ripple/ledger/RawView.h&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;ripple/ledger/detail/ApplyViewBase.h&gt;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classripple_1_1Sandbox.html"> 34</a></span>&#160;<span class="keyword">class </span><a class="code" href="classripple_1_1Sandbox.html">Sandbox</a> : <span class="keyword">public</span> <a class="code" href="classripple_1_1detail_1_1ApplyViewBase.html">detail::ApplyViewBase</a></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;{</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <a class="code" href="classripple_1_1Sandbox.html#a6a70cf1f6bbc5f7147ee86e5fbe598bb">Sandbox</a>() = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="classripple_1_1Sandbox.html#a6a70cf1f6bbc5f7147ee86e5fbe598bb">Sandbox</a>(<a class="code" href="classripple_1_1Sandbox.html">Sandbox</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="classripple_1_1Sandbox.html">Sandbox</a>&amp;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="classripple_1_1Sandbox.html#a71ba221147635ad55f754662ccf67d45">operator=</a>(<a class="code" href="classripple_1_1Sandbox.html">Sandbox</a>&amp;&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="classripple_1_1Sandbox.html">Sandbox</a>&amp;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <a class="code" href="classripple_1_1Sandbox.html#a71ba221147635ad55f754662ccf67d45">operator=</a>(<a class="code" href="classripple_1_1Sandbox.html">Sandbox</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <a class="code" href="classripple_1_1Sandbox.html#a6a70cf1f6bbc5f7147ee86e5fbe598bb">Sandbox</a>(<a class="code" href="classripple_1_1Sandbox.html">Sandbox</a>&amp;&amp;) = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classripple_1_1Sandbox.html#a99ee99ac970d7d3d71f46f14073d5506"> 46</a></span>&#160; <a class="code" href="classripple_1_1Sandbox.html#a99ee99ac970d7d3d71f46f14073d5506">Sandbox</a>(<a class="code" href="classripple_1_1ReadView.html">ReadView</a> <span class="keyword">const</span>* base, <a class="code" href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ApplyFlags</a> <a class="code" href="classripple_1_1detail_1_1ApplyViewBase.html#ad615aed650814602031c446241bbca10">flags</a>) : <a class="code" href="classripple_1_1detail_1_1ApplyViewBase.html#a18d0784d266ce17d5d25df3c13ce31aa">ApplyViewBase</a>(base, <a class="code" href="classripple_1_1detail_1_1ApplyViewBase.html#ad615aed650814602031c446241bbca10">flags</a>)</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; {</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; }</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classripple_1_1Sandbox.html#a3d25762116bfe0817d30159297d28f8a"> 50</a></span>&#160; <a class="code" href="classripple_1_1Sandbox.html#a3d25762116bfe0817d30159297d28f8a">Sandbox</a>(<a class="code" href="classripple_1_1ApplyView.html">ApplyView</a> <span class="keyword">const</span>* base) : <a class="code" href="classripple_1_1Sandbox.html">Sandbox</a>(base, base-&gt;<a class="code" href="classripple_1_1detail_1_1ApplyViewBase.html#ad615aed650814602031c446241bbca10">flags</a>())</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; {</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; }</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordtype">void</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classripple_1_1Sandbox.html#af027065a92ed80c4b54b08d7974c06ce"> 55</a></span>&#160; <a class="code" href="classripple_1_1Sandbox.html#af027065a92ed80c4b54b08d7974c06ce">apply</a>(<a class="code" href="classripple_1_1RawView.html">RawView</a>&amp; to)</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; {</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <a class="code" href="classripple_1_1detail_1_1ApplyViewBase.html#a70888ae5727e45067b092a465e8b4552">items_</a>.<a class="code" href="classripple_1_1detail_1_1ApplyStateTable.html#ac71c446d6cd8570add6765c71d5f8e8d">apply</a>(to);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; }</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;};</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;} <span class="comment">// namespace ripple</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassripple_1_1Sandbox_html_af027065a92ed80c4b54b08d7974c06ce"><div class="ttname"><a href="classripple_1_1Sandbox.html#af027065a92ed80c4b54b08d7974c06ce">ripple::Sandbox::apply</a></div><div class="ttdeci">void apply(RawView &amp;to)</div><div class="ttdef"><b>Definition:</b> <a href="Sandbox_8h_source.html#l00055">Sandbox.h:55</a></div></div>
<div class="ttc" id="anamespaceripple_html_ad2487abbcc1a5d6064b72144b461df6e"><div class="ttname"><a href="namespaceripple.html#ad2487abbcc1a5d6064b72144b461df6e">ripple::ApplyFlags</a></div><div class="ttdeci">ApplyFlags</div><div class="ttdef"><b>Definition:</b> <a href="ApplyView_8h_source.html#l00029">ApplyView.h:29</a></div></div>
<div class="ttc" id="aclassripple_1_1detail_1_1ApplyViewBase_html_a70888ae5727e45067b092a465e8b4552"><div class="ttname"><a href="classripple_1_1detail_1_1ApplyViewBase.html#a70888ae5727e45067b092a465e8b4552">ripple::detail::ApplyViewBase::items_</a></div><div class="ttdeci">detail::ApplyStateTable items_</div><div class="ttdef"><b>Definition:</b> <a href="ApplyViewBase_8h_source.html#l00125">ApplyViewBase.h:125</a></div></div>
<div class="ttc" id="aclassripple_1_1ApplyView_html"><div class="ttname"><a href="classripple_1_1ApplyView.html">ripple::ApplyView</a></div><div class="ttdoc">Writeable view to a ledger, for applying a transaction.</div><div class="ttdef"><b>Definition:</b> <a href="ApplyView_8h_source.html#l00134">ApplyView.h:134</a></div></div>
<div class="ttc" id="aclassripple_1_1detail_1_1ApplyViewBase_html_a18d0784d266ce17d5d25df3c13ce31aa"><div class="ttname"><a href="classripple_1_1detail_1_1ApplyViewBase.html#a18d0784d266ce17d5d25df3c13ce31aa">ripple::detail::ApplyViewBase::ApplyViewBase</a></div><div class="ttdeci">ApplyViewBase()=delete</div></div>
<div class="ttc" id="aclassripple_1_1RawView_html"><div class="ttname"><a href="classripple_1_1RawView.html">ripple::RawView</a></div><div class="ttdoc">Interface for ledger entry changes.</div><div class="ttdef"><b>Definition:</b> <a href="RawView_8h_source.html#l00036">RawView.h:36</a></div></div>
<div class="ttc" id="aclassripple_1_1detail_1_1ApplyStateTable_html_ac71c446d6cd8570add6765c71d5f8e8d"><div class="ttname"><a href="classripple_1_1detail_1_1ApplyStateTable.html#ac71c446d6cd8570add6765c71d5f8e8d">ripple::detail::ApplyStateTable::apply</a></div><div class="ttdeci">void apply(RawView &amp;to) const</div><div class="ttdef"><b>Definition:</b> <a href="ApplyStateTable_8cpp_source.html#l00031">ApplyStateTable.cpp:31</a></div></div>
<div class="ttc" id="aclassripple_1_1Sandbox_html"><div class="ttname"><a href="classripple_1_1Sandbox.html">ripple::Sandbox</a></div><div class="ttdoc">Discardable, editable view to a ledger.</div><div class="ttdef"><b>Definition:</b> <a href="Sandbox_8h_source.html#l00034">Sandbox.h:34</a></div></div>
<div class="ttc" id="aclassripple_1_1detail_1_1ApplyViewBase_html_ad615aed650814602031c446241bbca10"><div class="ttname"><a href="classripple_1_1detail_1_1ApplyViewBase.html#ad615aed650814602031c446241bbca10">ripple::detail::ApplyViewBase::flags</a></div><div class="ttdeci">ApplyFlags flags() const override</div><div class="ttdoc">Returns the tx apply flags.</div><div class="ttdef"><b>Definition:</b> <a href="ApplyViewBase_8cpp_source.html#l00122">ApplyViewBase.cpp:122</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#l00125">ReadView.h:125</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="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
<div class="ttc" id="aclassripple_1_1Sandbox_html_a6a70cf1f6bbc5f7147ee86e5fbe598bb"><div class="ttname"><a href="classripple_1_1Sandbox.html#a6a70cf1f6bbc5f7147ee86e5fbe598bb">ripple::Sandbox::Sandbox</a></div><div class="ttdeci">Sandbox()=delete</div></div>
<div class="ttc" id="aclassripple_1_1Sandbox_html_a3d25762116bfe0817d30159297d28f8a"><div class="ttname"><a href="classripple_1_1Sandbox.html#a3d25762116bfe0817d30159297d28f8a">ripple::Sandbox::Sandbox</a></div><div class="ttdeci">Sandbox(ApplyView const *base)</div><div class="ttdef"><b>Definition:</b> <a href="Sandbox_8h_source.html#l00050">Sandbox.h:50</a></div></div>
<div class="ttc" id="aclassripple_1_1detail_1_1ApplyViewBase_html"><div class="ttname"><a href="classripple_1_1detail_1_1ApplyViewBase.html">ripple::detail::ApplyViewBase</a></div><div class="ttdef"><b>Definition:</b> <a href="ApplyViewBase_8h_source.html#l00032">ApplyViewBase.h:32</a></div></div>
<div class="ttc" id="aclassripple_1_1Sandbox_html_a99ee99ac970d7d3d71f46f14073d5506"><div class="ttname"><a href="classripple_1_1Sandbox.html#a99ee99ac970d7d3d71f46f14073d5506">ripple::Sandbox::Sandbox</a></div><div class="ttdeci">Sandbox(ReadView const *base, ApplyFlags flags)</div><div class="ttdef"><b>Definition:</b> <a href="Sandbox_8h_source.html#l00046">Sandbox.h:46</a></div></div>
<div class="ttc" id="aclassripple_1_1Sandbox_html_a71ba221147635ad55f754662ccf67d45"><div class="ttname"><a href="classripple_1_1Sandbox.html#a71ba221147635ad55f754662ccf67d45">ripple::Sandbox::operator=</a></div><div class="ttdeci">Sandbox &amp; operator=(Sandbox &amp;&amp;)=delete</div></div>
<!-- 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>