ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 19:15:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e1dae4fb62ce2d05ca34c66a26724e0568d0f75a
rippled/RawView_8h_source.html
bthomee 099ba7da4d deploy: dc8b37a524
2025-09-18 08:15:26 -07:00

175 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" 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: RawView.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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0103a8ad82dcc2c51f5cde661b4b5cb7.html">xrpl</a></li><li class="navelem"><a class="el" href="dir_f732c880ba22363365bbd638a4cc259a.html">ledger</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">RawView.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="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">/*</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"></span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">*/</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">//==============================================================================</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifndef RIPPLE_LEDGER_RAWVIEW_H_INCLUDED</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define RIPPLE_LEDGER_RAWVIEW_H_INCLUDED</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &lt;xrpl/ledger/ReadView.h&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &lt;xrpl/protocol/STLedgerEntry.h&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;xrpl/protocol/Serializer.h&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="foldopen" id="foldopen00033" data-start="{" data-end="};">
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="classripple_1_1RawView.html"> 33</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1RawView.html">RawView</a></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span>{</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="classripple_1_1RawView.html#a9bdaa1e7d96c41fd07d44a3ccc6e8c0e"> 36</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classripple_1_1RawView.html#a9bdaa1e7d96c41fd07d44a3ccc6e8c0e">~RawView</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="classripple_1_1RawView.html#abbdbbc9799c838cdd2af9554558e01c9"> 37</a></span> <a class="code hl_function" href="classripple_1_1RawView.html#abbdbbc9799c838cdd2af9554558e01c9">RawView</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="classripple_1_1RawView.html#a5c6a7a0fb8de08c59aaf7bf4e9174537"> 38</a></span> <a class="code hl_function" href="classripple_1_1RawView.html#a5c6a7a0fb8de08c59aaf7bf4e9174537">RawView</a>(<a class="code hl_class" href="classripple_1_1RawView.html">RawView</a> <span class="keyword">const</span>&amp;) = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <a class="code hl_class" href="classripple_1_1RawView.html">RawView</a>&amp;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="classripple_1_1RawView.html#af0b436ab3082946f31da7c042c1b04a4"> 40</a></span> <a class="code hl_function" href="classripple_1_1RawView.html#af0b436ab3082946f31da7c042c1b04a4">operator=</a>(<a class="code hl_class" href="classripple_1_1RawView.html">RawView</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classripple_1_1RawView.html#ae90031cd2242cf34aeb93fbdbf92cfb8"> 48</a></span> <a class="code hl_function" href="classripple_1_1RawView.html#ae90031cd2242cf34aeb93fbdbf92cfb8">rawErase</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;SLE&gt;</a> <span class="keyword">const</span>&amp; sle) = 0;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="classripple_1_1RawView.html#a144f9ecbd046e28918d273728ad91eb0"> 62</a></span> <a class="code hl_function" href="classripple_1_1RawView.html#a144f9ecbd046e28918d273728ad91eb0">rawInsert</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;SLE&gt;</a> <span class="keyword">const</span>&amp; sle) = 0;</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="classripple_1_1RawView.html#ad27fcee888dd020ca39a2327d1a5f19c"> 77</a></span> <a class="code hl_function" href="classripple_1_1RawView.html#ad27fcee888dd020ca39a2327d1a5f19c">rawReplace</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;SLE&gt;</a> <span class="keyword">const</span>&amp; sle) = 0;</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="classripple_1_1RawView.html#accebb9124b44b63080c236f01e070a1e"> 84</a></span> <a class="code hl_function" href="classripple_1_1RawView.html#accebb9124b44b63080c236f01e070a1e">rawDestroyXRP</a>(<a class="code hl_class" href="classripple_1_1XRPAmount.html">XRPAmount</a> <span class="keyword">const</span>&amp; fee) = 0;</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span>};</div>
</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="foldopen" id="foldopen00094" data-start="{" data-end="};">
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"><a class="line" href="classripple_1_1TxsRawView.html"> 94</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1TxsRawView.html">TxsRawView</a> : <span class="keyword">public</span> <a class="code hl_class" href="classripple_1_1RawView.html">RawView</a></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span>{</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"><a class="line" href="classripple_1_1TxsRawView.html#af0a1537fc962314ebc611a569e366368"> 103</a></span> <a class="code hl_function" href="classripple_1_1TxsRawView.html#af0a1537fc962314ebc611a569e366368">rawTxInsert</a>(</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <a class="code hl_class" href="classripple_1_1base__uint.html">ReadView::key_type</a> <span class="keyword">const</span>&amp; key,</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;Serializer const&gt;</a> <span class="keyword">const</span>&amp; txn,</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;Serializer const&gt;</a> <span class="keyword">const</span>&amp; metaData) = 0;</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span>};</div>
</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span><span class="preprocessor">#endif</span></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#l00033">RawView.h:34</a></div></div>
<div class="ttc" id="aclassripple_1_1RawView_html_a144f9ecbd046e28918d273728ad91eb0"><div class="ttname"><a href="classripple_1_1RawView.html#a144f9ecbd046e28918d273728ad91eb0">ripple::RawView::rawInsert</a></div><div class="ttdeci">virtual void rawInsert(std::shared_ptr&lt; SLE &gt; const &amp;sle)=0</div><div class="ttdoc">Unconditionally insert a state item.</div></div>
<div class="ttc" id="aclassripple_1_1RawView_html_a5c6a7a0fb8de08c59aaf7bf4e9174537"><div class="ttname"><a href="classripple_1_1RawView.html#a5c6a7a0fb8de08c59aaf7bf4e9174537">ripple::RawView::RawView</a></div><div class="ttdeci">RawView(RawView const &amp;)=default</div></div>
<div class="ttc" id="aclassripple_1_1RawView_html_a9bdaa1e7d96c41fd07d44a3ccc6e8c0e"><div class="ttname"><a href="classripple_1_1RawView.html#a9bdaa1e7d96c41fd07d44a3ccc6e8c0e">ripple::RawView::~RawView</a></div><div class="ttdeci">virtual ~RawView()=default</div></div>
<div class="ttc" id="aclassripple_1_1RawView_html_abbdbbc9799c838cdd2af9554558e01c9"><div class="ttname"><a href="classripple_1_1RawView.html#abbdbbc9799c838cdd2af9554558e01c9">ripple::RawView::RawView</a></div><div class="ttdeci">RawView()=default</div></div>
<div class="ttc" id="aclassripple_1_1RawView_html_accebb9124b44b63080c236f01e070a1e"><div class="ttname"><a href="classripple_1_1RawView.html#accebb9124b44b63080c236f01e070a1e">ripple::RawView::rawDestroyXRP</a></div><div class="ttdeci">virtual void rawDestroyXRP(XRPAmount const &amp;fee)=0</div><div class="ttdoc">Destroy XRP.</div></div>
<div class="ttc" id="aclassripple_1_1RawView_html_ad27fcee888dd020ca39a2327d1a5f19c"><div class="ttname"><a href="classripple_1_1RawView.html#ad27fcee888dd020ca39a2327d1a5f19c">ripple::RawView::rawReplace</a></div><div class="ttdeci">virtual void rawReplace(std::shared_ptr&lt; SLE &gt; const &amp;sle)=0</div><div class="ttdoc">Unconditionally replace a state item.</div></div>
<div class="ttc" id="aclassripple_1_1RawView_html_ae90031cd2242cf34aeb93fbdbf92cfb8"><div class="ttname"><a href="classripple_1_1RawView.html#ae90031cd2242cf34aeb93fbdbf92cfb8">ripple::RawView::rawErase</a></div><div class="ttdeci">virtual void rawErase(std::shared_ptr&lt; SLE &gt; const &amp;sle)=0</div><div class="ttdoc">Delete an existing state item.</div></div>
<div class="ttc" id="aclassripple_1_1RawView_html_af0b436ab3082946f31da7c042c1b04a4"><div class="ttname"><a href="classripple_1_1RawView.html#af0b436ab3082946f31da7c042c1b04a4">ripple::RawView::operator=</a></div><div class="ttdeci">RawView &amp; operator=(RawView const &amp;)=delete</div></div>
<div class="ttc" id="aclassripple_1_1TxsRawView_html"><div class="ttname"><a href="classripple_1_1TxsRawView.html">ripple::TxsRawView</a></div><div class="ttdoc">Interface for changing ledger entries with transactions.</div><div class="ttdef"><b>Definition</b> <a href="RawView_8h_source.html#l00094">RawView.h:95</a></div></div>
<div class="ttc" id="aclassripple_1_1TxsRawView_html_af0a1537fc962314ebc611a569e366368"><div class="ttname"><a href="classripple_1_1TxsRawView.html#af0a1537fc962314ebc611a569e366368">ripple::TxsRawView::rawTxInsert</a></div><div class="ttdeci">virtual void rawTxInsert(ReadView::key_type const &amp;key, std::shared_ptr&lt; Serializer const &gt; const &amp;txn, std::shared_ptr&lt; Serializer const &gt; const &amp;metaData)=0</div><div class="ttdoc">Add a transaction to the tx map.</div></div>
<div class="ttc" id="aclassripple_1_1XRPAmount_html"><div class="ttname"><a href="classripple_1_1XRPAmount.html">ripple::XRPAmount</a></div><div class="ttdef"><b>Definition</b> <a href="XRPAmount_8h_source.html#l00039">XRPAmount.h:43</a></div></div>
<div class="ttc" id="aclassripple_1_1base__uint_html"><div class="ttname"><a href="classripple_1_1base__uint.html">ripple::base_uint&lt; 256 &gt;</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#l00025">algorithm.h:25</a></div></div>
<div class="ttc" id="ashared_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</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>
Reference in New Issue View Git Blame Copy Permalink