Files
rippled/classripple_1_1TransactionStateSF.html
2022-05-11 23:57:28 +00:00

309 lines
17 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: ripple::TransactionStateSF 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 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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1TransactionStateSF.html">TransactionStateSF</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1TransactionStateSF-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::TransactionStateSF Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for ripple::TransactionStateSF:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1TransactionStateSF__inherit__graph.png" border="0" usemap="#ripple_1_1TransactionStateSF_inherit__map" alt="Inheritance graph"/></div>
<map name="ripple_1_1TransactionStateSF_inherit__map" id="ripple_1_1TransactionStateSF_inherit__map">
<area shape="rect" title=" " alt="" coords="5,80,196,107"/>
<area shape="rect" href="classripple_1_1SHAMapSyncFilter.html" title=" " alt="" coords="9,5,193,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ripple::TransactionStateSF:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1TransactionStateSF__coll__graph.png" border="0" usemap="#ripple_1_1TransactionStateSF_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1TransactionStateSF_coll__map" id="ripple_1_1TransactionStateSF_coll__map">
<area shape="rect" title=" " alt="" coords="1600,301,1791,328"/>
<area shape="rect" href="classripple_1_1SHAMapSyncFilter.html" title=" " alt="" coords="1339,243,1523,269"/>
<area shape="rect" href="classripple_1_1NodeStore_1_1Database.html" title="Persistency layer for NodeObject." alt="" coords="1360,294,1503,335"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="983,33,1126,60"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="978,84,1131,111"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,191,108,217"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="221,293,389,334"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="413,191,620,217"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/condition_variable.html" title=" " alt="" coords="969,372,1140,399"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="951,423,1158,449"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="666,423,769,449"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/mutex.html" title="STL class." alt="" coords="1009,473,1101,500"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="936,247,1173,347"/>
<area shape="rect" href="classripple_1_1base__uint.html" title="Integers of any length that is a multiple of 32&#45;bits." alt="" coords="647,277,788,318"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="261,241,349,268"/>
<area shape="rect" href="classripple_1_1NodeStore_1_1Scheduler.html" title="Scheduling for asynchronous backend activity." alt="" coords="983,525,1126,566"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="999,591,1110,617"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="644,591,791,617"/>
<area shape="rect" href="classripple_1_1AbstractFetchPackContainer.html" title="An interface facilitating retrieval of fetch packs without an application or ledgermaster object." alt="" coords="1339,359,1524,401"/>
</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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a62fd2ae2ec3ee446ccf19502217b494e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TransactionStateSF.html#a62fd2ae2ec3ee446ccf19502217b494e">TransactionStateSF</a> (<a class="el" href="classripple_1_1NodeStore_1_1Database.html">NodeStore::Database</a> &amp;db, <a class="el" href="classripple_1_1AbstractFetchPackContainer.html">AbstractFetchPackContainer</a> &amp;fp)</td></tr>
<tr class="separator:a62fd2ae2ec3ee446ccf19502217b494e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f879e777a9a6adfd8b680ff3048d0eb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TransactionStateSF.html#a2f879e777a9a6adfd8b680ff3048d0eb">gotNode</a> (bool fromFilter, <a class="el" href="classripple_1_1SHAMapHash.html">SHAMapHash</a> const &amp;nodeHash, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ledgerSeq, <a class="el" href="namespaceripple.html#ab1f2184bb5938b5508798cd47a561a21">Blob</a> &amp;&amp;nodeData, <a class="el" href="namespaceripple.html#ae0356b1de00f841c554c830be509dd58">SHAMapNodeType</a> type) const override</td></tr>
<tr class="separator:a2f879e777a9a6adfd8b680ff3048d0eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1820e2e81c8a10726d1d3b6e85632bf"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; <a class="el" href="namespaceripple.html#ab1f2184bb5938b5508798cd47a561a21">Blob</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TransactionStateSF.html#ac1820e2e81c8a10726d1d3b6e85632bf">getNode</a> (<a class="el" href="classripple_1_1SHAMapHash.html">SHAMapHash</a> const &amp;nodeHash) const override</td></tr>
<tr class="separator:ac1820e2e81c8a10726d1d3b6e85632bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a8943aa5bbf6ef194568367f0422b02e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1NodeStore_1_1Database.html">NodeStore::Database</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TransactionStateSF.html#a8943aa5bbf6ef194568367f0422b02e3">db_</a></td></tr>
<tr class="separator:a8943aa5bbf6ef194568367f0422b02e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad279915659d4e6927ceb722c817df5a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1AbstractFetchPackContainer.html">AbstractFetchPackContainer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TransactionStateSF.html#ad279915659d4e6927ceb722c817df5a5">fp_</a></td></tr>
<tr class="separator:ad279915659d4e6927ceb722c817df5a5"><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 class="definition">Definition at line <a class="el" href="TransactionStateSF_8h_source.html#l00031">31</a> of file <a class="el" href="TransactionStateSF_8h_source.html">TransactionStateSF.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a62fd2ae2ec3ee446ccf19502217b494e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62fd2ae2ec3ee446ccf19502217b494e">&#9670;&nbsp;</a></span>TransactionStateSF()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::TransactionStateSF::TransactionStateSF </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1NodeStore_1_1Database.html">NodeStore::Database</a> &amp;&#160;</td>
<td class="paramname"><em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1AbstractFetchPackContainer.html">AbstractFetchPackContainer</a> &amp;&#160;</td>
<td class="paramname"><em>fp</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="TransactionStateSF_8h_source.html#l00034">34</a> of file <a class="el" href="TransactionStateSF_8h_source.html">TransactionStateSF.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2f879e777a9a6adfd8b680ff3048d0eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f879e777a9a6adfd8b680ff3048d0eb">&#9670;&nbsp;</a></span>gotNode()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::TransactionStateSF::gotNode </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>fromFilter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1SHAMapHash.html">SHAMapHash</a> const &amp;&#160;</td>
<td class="paramname"><em>nodeHash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>&#160;</td>
<td class="paramname"><em>ledgerSeq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#ab1f2184bb5938b5508798cd47a561a21">Blob</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>nodeData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#ae0356b1de00f841c554c830be509dd58">SHAMapNodeType</a>&#160;</td>
<td class="paramname"><em>type</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classripple_1_1SHAMapSyncFilter.html#a52d6a1cab3037707977a764d146d939f">ripple::SHAMapSyncFilter</a>.</p>
<p class="definition">Definition at line <a class="el" href="TransactionStateSF_8cpp_source.html#l00025">25</a> of file <a class="el" href="TransactionStateSF_8cpp_source.html">TransactionStateSF.cpp</a>.</p>
</div>
</div>
<a id="ac1820e2e81c8a10726d1d3b6e85632bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1820e2e81c8a10726d1d3b6e85632bf">&#9670;&nbsp;</a></span>getNode()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; <a class="el" href="namespaceripple.html#ab1f2184bb5938b5508798cd47a561a21">Blob</a> &gt; ripple::TransactionStateSF::getNode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1SHAMapHash.html">SHAMapHash</a> const &amp;&#160;</td>
<td class="paramname"><em>nodeHash</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classripple_1_1SHAMapSyncFilter.html#aab30f4bd0cd629af0cb5a7f53afb7fb4">ripple::SHAMapSyncFilter</a>.</p>
<p class="definition">Definition at line <a class="el" href="TransactionStateSF_8cpp_source.html#l00042">42</a> of file <a class="el" href="TransactionStateSF_8cpp_source.html">TransactionStateSF.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a8943aa5bbf6ef194568367f0422b02e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8943aa5bbf6ef194568367f0422b02e3">&#9670;&nbsp;</a></span>db_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1NodeStore_1_1Database.html">NodeStore::Database</a>&amp; ripple::TransactionStateSF::db_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="TransactionStateSF_8h_source.html#l00051">51</a> of file <a class="el" href="TransactionStateSF_8h_source.html">TransactionStateSF.h</a>.</p>
</div>
</div>
<a id="ad279915659d4e6927ceb722c817df5a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad279915659d4e6927ceb722c817df5a5">&#9670;&nbsp;</a></span>fp_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1AbstractFetchPackContainer.html">AbstractFetchPackContainer</a>&amp; ripple::TransactionStateSF::fp_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="TransactionStateSF_8h_source.html#l00052">52</a> of file <a class="el" href="TransactionStateSF_8h_source.html">TransactionStateSF.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- 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>