ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 02:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/classripple_1_1TxsRawView.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

318 lines
18 KiB
HTML
Raw Permalink 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: ripple::TxsRawView Class 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 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>
<!-- 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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1TxsRawView.html">TxsRawView</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classripple_1_1TxsRawView-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::TxsRawView Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Interface for changing ledger entries with transactions.
<a href="classripple_1_1TxsRawView.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="RawView_8h_source.html">RawView.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ripple::TxsRawView:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1TxsRawView__inherit__graph.png" border="0" usemap="#aripple_1_1TxsRawView_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1TxsRawView_inherit__map" id="aripple_1_1TxsRawView_inherit__map">
<area shape="rect" title="Interface for changing ledger entries with transactions." alt="" coords="59,79,209,104"/>
<area shape="rect" href="classripple_1_1Ledger.html" title="Holds a ledger." alt="" coords="5,152,116,177"/>
<area shape="poly" title=" " alt="" coords="114,116,74,154,71,150,110,112"/>
<area shape="rect" href="classripple_1_1OpenView.html" title="Writable ledger view that accumulates state and tx changes." alt="" coords="141,152,274,177"/>
<area shape="poly" title=" " alt="" coords="158,112,197,150,194,154,154,116"/>
<area shape="rect" href="classripple_1_1RawView.html" title="Interface for ledger entry changes." alt="" coords="71,5,197,31"/>
<area shape="poly" title=" " alt="" coords="137,44,137,79,131,79,131,44"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ripple::TxsRawView:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1TxsRawView__coll__graph.png" border="0" usemap="#aripple_1_1TxsRawView_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1TxsRawView_coll__map" id="aripple_1_1TxsRawView_coll__map">
<area shape="rect" title="Interface for changing ledger entries with transactions." alt="" coords="5,79,156,104"/>
<area shape="rect" href="classripple_1_1RawView.html" title="Interface for ledger entry changes." alt="" coords="17,5,144,31"/>
<area shape="poly" title=" " alt="" coords="83,44,83,79,78,79,78,44"/>
</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 id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af0a1537fc962314ebc611a569e366368" id="r_af0a1537fc962314ebc611a569e366368"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TxsRawView.html#af0a1537fc962314ebc611a569e366368">rawTxInsert</a> (<a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">ReadView::key_type</a> const &amp;key, <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1Serializer.html">Serializer</a> const &gt; const &amp;txn, <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1Serializer.html">Serializer</a> const &gt; const &amp;metaData)=0</td></tr>
<tr class="memdesc:af0a1537fc962314ebc611a569e366368"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a transaction to the tx map. <br /></td></tr>
<tr class="separator:af0a1537fc962314ebc611a569e366368"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae90031cd2242cf34aeb93fbdbf92cfb8" id="r_ae90031cd2242cf34aeb93fbdbf92cfb8"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RawView.html#ae90031cd2242cf34aeb93fbdbf92cfb8">rawErase</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> &gt; const &amp;sle)=0</td></tr>
<tr class="memdesc:ae90031cd2242cf34aeb93fbdbf92cfb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete an existing state item. <br /></td></tr>
<tr class="separator:ae90031cd2242cf34aeb93fbdbf92cfb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a144f9ecbd046e28918d273728ad91eb0" id="r_a144f9ecbd046e28918d273728ad91eb0"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RawView.html#a144f9ecbd046e28918d273728ad91eb0">rawInsert</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> &gt; const &amp;sle)=0</td></tr>
<tr class="memdesc:a144f9ecbd046e28918d273728ad91eb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unconditionally insert a state item. <br /></td></tr>
<tr class="separator:a144f9ecbd046e28918d273728ad91eb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad27fcee888dd020ca39a2327d1a5f19c" id="r_ad27fcee888dd020ca39a2327d1a5f19c"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RawView.html#ad27fcee888dd020ca39a2327d1a5f19c">rawReplace</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> &gt; const &amp;sle)=0</td></tr>
<tr class="memdesc:ad27fcee888dd020ca39a2327d1a5f19c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unconditionally replace a state item. <br /></td></tr>
<tr class="separator:ad27fcee888dd020ca39a2327d1a5f19c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accebb9124b44b63080c236f01e070a1e" id="r_accebb9124b44b63080c236f01e070a1e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RawView.html#accebb9124b44b63080c236f01e070a1e">rawDestroyXRP</a> (<a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> const &amp;fee)=0</td></tr>
<tr class="memdesc:accebb9124b44b63080c236f01e070a1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy XRP. <br /></td></tr>
<tr class="separator:accebb9124b44b63080c236f01e070a1e"><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>Interface for changing ledger entries with transactions. </p>
<p>Allows raw modification of ledger entries and insertion of transactions into the transaction map. </p>
<p class="definition">Definition at line <a class="el" href="RawView_8h_source.html#l00075">75</a> of file <a class="el" href="RawView_8h_source.html">RawView.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="af0a1537fc962314ebc611a569e366368" name="af0a1537fc962314ebc611a569e366368"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0a1537fc962314ebc611a569e366368">&#9670;&#160;</a></span>rawTxInsert()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::TxsRawView::rawTxInsert </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1ReadView.html#a937328125a7d62270f32b4e1555c5cdd">ReadView::key_type</a> const &amp;&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1Serializer.html">Serializer</a> const &gt; const &amp;&#160;</td>
<td class="paramname"><em>txn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classripple_1_1Serializer.html">Serializer</a> const &gt; const &amp;&#160;</td>
<td class="paramname"><em>metaData</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a transaction to the tx map. </p>
<p>Closed ledgers must have metadata, while open ledgers omit metadata. </p>
<p>Implemented in <a class="el" href="classripple_1_1OpenView.html#ab230a32cbeedf37d8b30bbec8a91961d">ripple::OpenView</a>.</p>
</div>
</div>
<a id="ae90031cd2242cf34aeb93fbdbf92cfb8" name="ae90031cd2242cf34aeb93fbdbf92cfb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae90031cd2242cf34aeb93fbdbf92cfb8">&#9670;&#160;</a></span>rawErase()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::RawView::rawErase </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> &gt; const &amp;&#160;</td>
<td class="paramname"><em>sle</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete an existing state item. </p>
<p>The SLE is provided so the implementation can calculate metadata. </p>
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a781e62e909b6509b1863b7305295cb39">ripple::detail::ApplyViewBase</a>, <a class="el" href="classripple_1_1OpenView.html#ab8ec1fb6833f8962f766b214c580ab7b">ripple::OpenView</a>, and <a class="el" href="classripple_1_1Ledger.html#a27f6d838768ff645f63dbbca85160ab7">ripple::Ledger</a>.</p>
</div>
</div>
<a id="a144f9ecbd046e28918d273728ad91eb0" name="a144f9ecbd046e28918d273728ad91eb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a144f9ecbd046e28918d273728ad91eb0">&#9670;&#160;</a></span>rawInsert()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::RawView::rawInsert </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> &gt; const &amp;&#160;</td>
<td class="paramname"><em>sle</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Unconditionally insert a state item. </p>
<p>Requirements: The key must not already exist.</p>
<p>Effects: </p><pre class="fragment">The key is associated with the SLE.
</pre> <dl class="section note"><dt>Note</dt><dd>The key is taken from the SLE </dd></dl>
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#aacd0fa84b0681ca34739a9fddde754a0">ripple::detail::ApplyViewBase</a>, <a class="el" href="classripple_1_1OpenView.html#ad8795d23968108dca84420d2d25e1dd7">ripple::OpenView</a>, and <a class="el" href="classripple_1_1Ledger.html#a7ed6dcfefe77ee7b9e90e052df79e52d">ripple::Ledger</a>.</p>
</div>
</div>
<a id="ad27fcee888dd020ca39a2327d1a5f19c" name="ad27fcee888dd020ca39a2327d1a5f19c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad27fcee888dd020ca39a2327d1a5f19c">&#9670;&#160;</a></span>rawReplace()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::RawView::rawReplace </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="namespaceripple.html#abbba3966df1925ac76f6d04c0aa1abe3">SLE</a> &gt; const &amp;&#160;</td>
<td class="paramname"><em>sle</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Unconditionally replace a state item. </p>
<p>Requirements: </p><pre class="fragment">The key must exist.
</pre><p> Effects: </p><pre class="fragment">The key is associated with the SLE.
</pre> <dl class="section note"><dt>Note</dt><dd>The key is taken from the SLE </dd></dl>
<p>Implemented in <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a720bb7359587d757eff58b3f26ea4f94">ripple::detail::ApplyViewBase</a>, <a class="el" href="classripple_1_1OpenView.html#ad2a95c6fd9303d94164d55530cc1df39">ripple::OpenView</a>, and <a class="el" href="classripple_1_1Ledger.html#a210375076ddca23b7374efea0b34de4a">ripple::Ledger</a>.</p>
</div>
</div>
<a id="accebb9124b44b63080c236f01e070a1e" name="accebb9124b44b63080c236f01e070a1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#accebb9124b44b63080c236f01e070a1e">&#9670;&#160;</a></span>rawDestroyXRP()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void ripple::RawView::rawDestroyXRP </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1XRPAmount.html">XRPAmount</a> const &amp;&#160;</td>
<td class="paramname"><em>fee</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy XRP. </p>
<p>This is used to pay for transaction fees. </p>
<p>Implemented in <a class="el" href="classripple_1_1OpenView.html#a88584a83d760fe41178b3397359b7816">ripple::OpenView</a>, <a class="el" href="classripple_1_1Ledger.html#a12a86d2a4af573d10f76664259df1b1e">ripple::Ledger</a>, and <a class="el" href="classripple_1_1detail_1_1ApplyViewBase.html#a1c8f17e8aa8248be7d972ffecdd949a8">ripple::detail::ApplyViewBase</a>.</p>
</div>
</div>
</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