ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-06 17:27:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e2b7ef418d04a83b54b764be575c4400ca8e6dac
rippled/classripple_1_1Family.html
bthomee e61ca37029 deploy: eac3abdca9
2025-01-21 19:58:08 +00:00

585 lines
30 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.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::Family 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.5 -->
<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_1Family.html">Family</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_1Family-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::Family Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="Family_8h_source.html">Family.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ripple::Family:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1Family__inherit__graph.png" border="0" usemap="#aripple_1_1Family_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1Family_inherit__map" id="aripple_1_1Family_inherit__map">
<area shape="rect" title=" " alt="" coords="122,5,233,31"/>
<area shape="rect" href="classripple_1_1NodeFamily.html" title=" " alt="" coords="5,79,149,104"/>
<area shape="rect" href="classripple_1_1tests_1_1TestNodeFamily.html" title=" " alt="" coords="173,79,384,104"/>
</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:ad9c2be28150efd712386fb124ccfdeb9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#ad9c2be28150efd712386fb124ccfdeb9">Family</a> (<a class="el" href="classripple_1_1Family.html">Family</a> const &amp;)=delete</td></tr>
<tr class="separator:ad9c2be28150efd712386fb124ccfdeb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6fe24bc981b9527af16ea1a1d531ab2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#af6fe24bc981b9527af16ea1a1d531ab2">Family</a> (<a class="el" href="classripple_1_1Family.html">Family</a> &amp;&amp;)=delete</td></tr>
<tr class="separator:af6fe24bc981b9527af16ea1a1d531ab2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad97c2f6517c0a3875bcb01e83be701a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Family.html">Family</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#ad97c2f6517c0a3875bcb01e83be701a2">operator=</a> (<a class="el" href="classripple_1_1Family.html">Family</a> const &amp;)=delete</td></tr>
<tr class="separator:ad97c2f6517c0a3875bcb01e83be701a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafedb05a872ddcc592c9e2dd32452bf3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Family.html">Family</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#aafedb05a872ddcc592c9e2dd32452bf3">operator=</a> (<a class="el" href="classripple_1_1Family.html">Family</a> &amp;&amp;)=delete</td></tr>
<tr class="separator:aafedb05a872ddcc592c9e2dd32452bf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3c9358bb83bdee02793cef452c38f64"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#af3c9358bb83bdee02793cef452c38f64">Family</a> ()=default</td></tr>
<tr class="separator:af3c9358bb83bdee02793cef452c38f64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc97327a6e3f4e10783d397eebc9cbc0"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#acc97327a6e3f4e10783d397eebc9cbc0">~Family</a> ()=default</td></tr>
<tr class="separator:acc97327a6e3f4e10783d397eebc9cbc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf461d9cace24a7f95c0c917edad1ec7"><td class="memItemLeft" align="right" valign="top">virtual <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_1Family.html#acf461d9cace24a7f95c0c917edad1ec7">db</a> ()=0</td></tr>
<tr class="separator:acf461d9cace24a7f95c0c917edad1ec7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4fe7ced673d9f60664108c7ea449ca5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classripple_1_1NodeStore_1_1Database.html">NodeStore::Database</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#ab4fe7ced673d9f60664108c7ea449ca5">db</a> () const =0</td></tr>
<tr class="separator:ab4fe7ced673d9f60664108c7ea449ca5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55b2079797bfdd76d68558a7eb380ec1"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#a55b2079797bfdd76d68558a7eb380ec1">journal</a> ()=0</td></tr>
<tr class="separator:a55b2079797bfdd76d68558a7eb380ec1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3fc38122142593c76c2a28070607c3f9"><td class="memItemLeft" align="right" valign="top">virtual <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#ad18fcbe19742d7f978f16f21ac70fba5">FullBelowCache</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#a3fc38122142593c76c2a28070607c3f9">getFullBelowCache</a> ()=0</td></tr>
<tr class="memdesc:a3fc38122142593c76c2a28070607c3f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to the <a class="el" href="classripple_1_1Family.html">Family</a> Full Below Cache. <a href="classripple_1_1Family.html#a3fc38122142593c76c2a28070607c3f9">More...</a><br /></td></tr>
<tr class="separator:a3fc38122142593c76c2a28070607c3f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abeca3300256b01c3b204bacaea1dd92d"><td class="memItemLeft" align="right" valign="top">virtual <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#acffabb2b30913f9687dbf65f4afc0a19">TreeNodeCache</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#abeca3300256b01c3b204bacaea1dd92d">getTreeNodeCache</a> ()=0</td></tr>
<tr class="memdesc:abeca3300256b01c3b204bacaea1dd92d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to the <a class="el" href="classripple_1_1Family.html">Family</a> Tree Node Cache. <a href="classripple_1_1Family.html#abeca3300256b01c3b204bacaea1dd92d">More...</a><br /></td></tr>
<tr class="separator:abeca3300256b01c3b204bacaea1dd92d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ad0cea735f2bd07adc7b5ed7b3528b8"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#a3ad0cea735f2bd07adc7b5ed7b3528b8">sweep</a> ()=0</td></tr>
<tr class="separator:a3ad0cea735f2bd07adc7b5ed7b3528b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac747e6910394a7440db45af0aa222a11"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#ac747e6910394a7440db45af0aa222a11">missingNodeAcquireBySeq</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> refNum, <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;nodeHash)=0</td></tr>
<tr class="memdesc:ac747e6910394a7440db45af0aa222a11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Acquire ledger that has a missing node by ledger sequence. <a href="classripple_1_1Family.html#ac747e6910394a7440db45af0aa222a11">More...</a><br /></td></tr>
<tr class="separator:ac747e6910394a7440db45af0aa222a11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac23fa3820800431370db9197986d70f5"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#ac23fa3820800431370db9197986d70f5">missingNodeAcquireByHash</a> (<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;refHash, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> refNum)=0</td></tr>
<tr class="memdesc:ac23fa3820800431370db9197986d70f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Acquire ledger that has a missing node by ledger hash. <a href="classripple_1_1Family.html#ac23fa3820800431370db9197986d70f5">More...</a><br /></td></tr>
<tr class="separator:ac23fa3820800431370db9197986d70f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2711e78e7c2e33e24db3dfa5235eccd4"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#a2711e78e7c2e33e24db3dfa5235eccd4">reset</a> ()=0</td></tr>
<tr class="separator:a2711e78e7c2e33e24db3dfa5235eccd4"><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="Family_8h_source.html#l00032">32</a> of file <a class="el" href="Family_8h_source.html">Family.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad9c2be28150efd712386fb124ccfdeb9" name="ad9c2be28150efd712386fb124ccfdeb9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9c2be28150efd712386fb124ccfdeb9">&#9670;&#160;</a></span>Family() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::Family::Family </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Family.html">Family</a> const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af6fe24bc981b9527af16ea1a1d531ab2" name="af6fe24bc981b9527af16ea1a1d531ab2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6fe24bc981b9527af16ea1a1d531ab2">&#9670;&#160;</a></span>Family() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::Family::Family </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Family.html">Family</a> &amp;&amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af3c9358bb83bdee02793cef452c38f64" name="af3c9358bb83bdee02793cef452c38f64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3c9358bb83bdee02793cef452c38f64">&#9670;&#160;</a></span>Family() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::Family::Family </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acc97327a6e3f4e10783d397eebc9cbc0" name="acc97327a6e3f4e10783d397eebc9cbc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc97327a6e3f4e10783d397eebc9cbc0">&#9670;&#160;</a></span>~Family()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ripple::Family::~Family </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad97c2f6517c0a3875bcb01e83be701a2" name="ad97c2f6517c0a3875bcb01e83be701a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad97c2f6517c0a3875bcb01e83be701a2">&#9670;&#160;</a></span>operator=() <span class="overload">[1/2]</span></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_1Family.html">Family</a> &amp; ripple::Family::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Family.html">Family</a> const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aafedb05a872ddcc592c9e2dd32452bf3" name="aafedb05a872ddcc592c9e2dd32452bf3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafedb05a872ddcc592c9e2dd32452bf3">&#9670;&#160;</a></span>operator=() <span class="overload">[2/2]</span></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_1Family.html">Family</a> &amp; ripple::Family::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Family.html">Family</a> &amp;&amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acf461d9cace24a7f95c0c917edad1ec7" name="acf461d9cace24a7f95c0c917edad1ec7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf461d9cace24a7f95c0c917edad1ec7">&#9670;&#160;</a></span>db() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classripple_1_1NodeStore_1_1Database.html">NodeStore::Database</a> &amp; ripple::Family::db </td>
<td>(</td>
<td class="paramname"></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>Implemented in <a class="el" href="classripple_1_1tests_1_1TestNodeFamily.html#a2b0cb31c84e436105fcc58ce6e663e0a">ripple::tests::TestNodeFamily</a>, and <a class="el" href="classripple_1_1NodeFamily.html#a7fd5480adc222c07b32ccc35c4ff9d60">ripple::NodeFamily</a>.</p>
</div>
</div>
<a id="ab4fe7ced673d9f60664108c7ea449ca5" name="ab4fe7ced673d9f60664108c7ea449ca5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4fe7ced673d9f60664108c7ea449ca5">&#9670;&#160;</a></span>db() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classripple_1_1NodeStore_1_1Database.html">NodeStore::Database</a> const &amp; ripple::Family::db </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Implemented in <a class="el" href="classripple_1_1tests_1_1TestNodeFamily.html#abce472e2351b0576ce336a606b18041b">ripple::tests::TestNodeFamily</a>, and <a class="el" href="classripple_1_1NodeFamily.html#acdc749627baf634ed3ebb843163f1fc0">ripple::NodeFamily</a>.</p>
</div>
</div>
<a id="a55b2079797bfdd76d68558a7eb380ec1" name="a55b2079797bfdd76d68558a7eb380ec1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55b2079797bfdd76d68558a7eb380ec1">&#9670;&#160;</a></span>journal()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const &amp; ripple::Family::journal </td>
<td>(</td>
<td class="paramname"></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>Implemented in <a class="el" href="classripple_1_1tests_1_1TestNodeFamily.html#a1f85520d60a24c38e9288ff7995bfac7">ripple::tests::TestNodeFamily</a>, and <a class="el" href="classripple_1_1NodeFamily.html#a9381d149199c09bb1d39f9de63c58faf">ripple::NodeFamily</a>.</p>
</div>
</div>
<a id="a3fc38122142593c76c2a28070607c3f9" name="a3fc38122142593c76c2a28070607c3f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3fc38122142593c76c2a28070607c3f9">&#9670;&#160;</a></span>getFullBelowCache()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <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#ad18fcbe19742d7f978f16f21ac70fba5">FullBelowCache</a> &gt; ripple::Family::getFullBelowCache </td>
<td>(</td>
<td class="paramname"></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>Return a pointer to the <a class="el" href="classripple_1_1Family.html">Family</a> Full Below Cache. </p>
<p>Implemented in <a class="el" href="classripple_1_1tests_1_1TestNodeFamily.html#ac64db47bc2fe150b8aac64bdbe3d6dd2">ripple::tests::TestNodeFamily</a>, and <a class="el" href="classripple_1_1NodeFamily.html#ad97b83b7e564d41a278bbee8bb3b0762">ripple::NodeFamily</a>.</p>
</div>
</div>
<a id="abeca3300256b01c3b204bacaea1dd92d" name="abeca3300256b01c3b204bacaea1dd92d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abeca3300256b01c3b204bacaea1dd92d">&#9670;&#160;</a></span>getTreeNodeCache()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <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#acffabb2b30913f9687dbf65f4afc0a19">TreeNodeCache</a> &gt; ripple::Family::getTreeNodeCache </td>
<td>(</td>
<td class="paramname"></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>Return a pointer to the <a class="el" href="classripple_1_1Family.html">Family</a> Tree Node Cache. </p>
<p>Implemented in <a class="el" href="classripple_1_1tests_1_1TestNodeFamily.html#a3527d4b28dd48e65a9860c89778f0155">ripple::tests::TestNodeFamily</a>, and <a class="el" href="classripple_1_1NodeFamily.html#a2657a7b59edea5a002b80d9b217c4769">ripple::NodeFamily</a>.</p>
</div>
</div>
<a id="a3ad0cea735f2bd07adc7b5ed7b3528b8" name="a3ad0cea735f2bd07adc7b5ed7b3528b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ad0cea735f2bd07adc7b5ed7b3528b8">&#9670;&#160;</a></span>sweep()</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::Family::sweep </td>
<td>(</td>
<td class="paramname"></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>Implemented in <a class="el" href="classripple_1_1tests_1_1TestNodeFamily.html#a5db2c83c9acdf0cf011b1996f29ff5e1">ripple::tests::TestNodeFamily</a>, and <a class="el" href="classripple_1_1NodeFamily.html#a656e8cb2fa08a2f5549c9b42228b5d57">ripple::NodeFamily</a>.</p>
</div>
</div>
<a id="ac747e6910394a7440db45af0aa222a11" name="ac747e6910394a7440db45af0aa222a11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac747e6910394a7440db45af0aa222a11">&#9670;&#160;</a></span>missingNodeAcquireBySeq()</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::Family::missingNodeAcquireBySeq </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>refNum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;&#160;</td>
<td class="paramname"><em>nodeHash</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>Acquire ledger that has a missing node by ledger sequence. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">refNum</td><td>Sequence of ledger to acquire. </td></tr>
<tr><td class="paramname">nodeHash</td><td>Hash of missing node to report in throw. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classripple_1_1tests_1_1TestNodeFamily.html#a4295cbf58bcee1b440f80b9b0aae1688">ripple::tests::TestNodeFamily</a>, and <a class="el" href="classripple_1_1NodeFamily.html#adb2b0b53e7139b05b5be6e49ec5adbdb">ripple::NodeFamily</a>.</p>
</div>
</div>
<a id="ac23fa3820800431370db9197986d70f5" name="ac23fa3820800431370db9197986d70f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac23fa3820800431370db9197986d70f5">&#9670;&#160;</a></span>missingNodeAcquireByHash()</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::Family::missingNodeAcquireByHash </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;&#160;</td>
<td class="paramname"><em>refHash</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>refNum</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>Acquire ledger that has a missing node by ledger hash. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">refHash</td><td>Hash of ledger to acquire. </td></tr>
<tr><td class="paramname">refNum</td><td><a class="el" href="classripple_1_1Ledger.html" title="Holds a ledger.">Ledger</a> sequence with missing node. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classripple_1_1NodeFamily.html#aaff046022609b326460dc84bf444b7dc">ripple::NodeFamily</a>, and <a class="el" href="classripple_1_1tests_1_1TestNodeFamily.html#a7a68a8a2ad6b5a10f521847d4f382a4b">ripple::tests::TestNodeFamily</a>.</p>
</div>
</div>
<a id="a2711e78e7c2e33e24db3dfa5235eccd4" name="a2711e78e7c2e33e24db3dfa5235eccd4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2711e78e7c2e33e24db3dfa5235eccd4">&#9670;&#160;</a></span>reset()</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::Family::reset </td>
<td>(</td>
<td class="paramname"></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>Implemented in <a class="el" href="classripple_1_1tests_1_1TestNodeFamily.html#a1f76e62e5e7675389c08622c7cbcd292">ripple::tests::TestNodeFamily</a>, and <a class="el" href="classripple_1_1NodeFamily.html#acd15a63c12f9d7bfd363ef35707171da">ripple::NodeFamily</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.5
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink