mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-22 03:55:53 +00:00
172 lines
20 KiB
HTML
172 lines
20 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: 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 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&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&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">RawView.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a 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 name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a 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 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 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 name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a 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 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 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 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 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 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 name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef RIPPLE_LEDGER_RAWVIEW_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_LEDGER_RAWVIEW_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <ripple/ledger/ReadView.h></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <ripple/protocol/Serializer.h></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <ripple/protocol/STLedgerEntry.h></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <boost/optional.hpp></span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a>></span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/memory.html">memory</a>></span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/utility.html">utility</a>></span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classripple_1_1RawView.html"> 37</a></span> <span class="keyword">class </span><a class="code" href="classripple_1_1RawView.html">RawView</a></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> {</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">virtual</span> <a class="code" href="classripple_1_1RawView.html#a9bdaa1e7d96c41fd07d44a3ccc6e8c0e">~RawView</a>() = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="classripple_1_1RawView.html#abbdbbc9799c838cdd2af9554558e01c9">RawView</a>() = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="classripple_1_1RawView.html#abbdbbc9799c838cdd2af9554558e01c9">RawView</a>(<a class="code" href="classripple_1_1RawView.html">RawView</a> <span class="keyword">const</span>&) = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="classripple_1_1RawView.html">RawView</a>& <a class="code" href="classripple_1_1RawView.html#a3091a671f8a4444822c0677420d2fe81">operator=</a>(<a class="code" href="classripple_1_1RawView.html">RawView</a> <span class="keyword">const</span>&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">virtual</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="classripple_1_1RawView.html#ae90031cd2242cf34aeb93fbdbf92cfb8">rawErase</a> (<a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr<SLE></a> <span class="keyword">const</span>& sle) = 0;</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">virtual</span></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <a class="code" href="classripple_1_1RawView.html#a144f9ecbd046e28918d273728ad91eb0">rawInsert</a> (<a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr<SLE></a> <span class="keyword">const</span>& sle) = 0;</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keyword">virtual</span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <a class="code" href="classripple_1_1RawView.html#ad27fcee888dd020ca39a2327d1a5f19c">rawReplace</a> (<a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr<SLE></a> <span class="keyword">const</span>& sle) = 0;</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">virtual</span></div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <a class="code" href="classripple_1_1RawView.html#accebb9124b44b63080c236f01e070a1e">rawDestroyXRP</a> (<a class="code" href="classripple_1_1XRPAmount.html">XRPAmount</a> <span class="keyword">const</span>& fee) = 0;</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> };</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  </div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  </div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="classripple_1_1TxsRawView.html"> 101</a></span> <span class="keyword">class </span><a class="code" href="classripple_1_1TxsRawView.html">TxsRawView</a> : <span class="keyword">public</span> <a class="code" href="classripple_1_1RawView.html">RawView</a></div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> {</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keyword">virtual</span></div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <a class="code" href="classripple_1_1TxsRawView.html#af0a1537fc962314ebc611a569e366368">rawTxInsert</a> (<a class="code" href="classripple_1_1base__uint.html">ReadView::key_type</a> <span class="keyword">const</span>& key,</div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr<Serializer const></a></div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">const</span>& txn, <a class="codeRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a><</div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <a class="code" href="classripple_1_1Serializer.html">Serializer</a> <span class="keyword">const</span>> <span class="keyword">const</span>& metaData) = 0;</div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> };</div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  </div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> } <span class="comment">// ripple</span></div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  </div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<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="ashared_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a></div><div class="ttdoc">STL class.</div></div>
|
|
<div class="ttc" id="autility_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/utility.html">utility</a></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 &fee)=0</div><div class="ttdoc">Destroy XRP.</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_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< SLE > const &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< SLE > const &sle)=0</div><div class="ttdoc">Delete an existing state item.</div></div>
|
|
<div class="ttc" id="aclassripple_1_1base__uint_html"><div class="ttname"><a href="classripple_1_1base__uint.html">ripple::base_uint< 256 ></a></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#l00037">RawView.h:37</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 &key, std::shared_ptr< Serializer const > const &txn, std::shared_ptr< Serializer const > const &metaData)=0</div><div class="ttdoc">Add a transaction to the tx map.</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< SLE > const &sle)=0</div><div class="ttdoc">Unconditionally insert a state item.</div></div>
|
|
<div class="ttc" id="acstdint_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a></div></div>
|
|
<div class="ttc" id="amemory_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/memory.html">memory</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Serializer_html"><div class="ttname"><a href="classripple_1_1Serializer.html">ripple::Serializer</a></div><div class="ttdef"><b>Definition:</b> <a href="Serializer_8h_source.html#l00043">Serializer.h:43</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_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#l00101">RawView.h:101</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1RawView_html_a3091a671f8a4444822c0677420d2fe81"><div class="ttname"><a href="classripple_1_1RawView.html#a3091a671f8a4444822c0677420d2fe81">ripple::RawView::operator=</a></div><div class="ttdeci">RawView & operator=(RawView const &)=delete</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#l00046">XRPAmount.h:46</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|