mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
594 lines
31 KiB
HTML
594 lines
31 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::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 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="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> |
|
|
<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">
|
|
<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="#ripple_1_1Family_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="ripple_1_1Family_inherit__map" id="ripple_1_1Family_inherit__map">
|
|
<area shape="rect" title=" " alt="" coords="191,5,302,32"/>
|
|
<area shape="rect" href="classripple_1_1NodeFamily.html" title=" " alt="" coords="5,80,149,107"/>
|
|
<area shape="rect" href="classripple_1_1ShardFamily.html" title=" " alt="" coords="173,80,320,107"/>
|
|
<area shape="rect" href="classripple_1_1tests_1_1TestNodeFamily.html" title=" " alt="" coords="344,80,555,107"/>
|
|
</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:ad9c2be28150efd712386fb124ccfdeb9"><td class="memItemLeft" align="right" valign="top"> </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 &)=delete</td></tr>
|
|
<tr class="separator:ad9c2be28150efd712386fb124ccfdeb9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af6fe24bc981b9527af16ea1a1d531ab2"><td class="memItemLeft" align="right" valign="top"> </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> &&)=delete</td></tr>
|
|
<tr class="separator:af6fe24bc981b9527af16ea1a1d531ab2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a07ace65397c6fe5be9674420a8def04b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Family.html">Family</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#a07ace65397c6fe5be9674420a8def04b">operator=</a> (<a class="el" href="classripple_1_1Family.html">Family</a> const &)=delete</td></tr>
|
|
<tr class="separator:a07ace65397c6fe5be9674420a8def04b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb0c51695af2eda2cda16ca68c2b6ec7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Family.html">Family</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#abb0c51695af2eda2cda16ca68c2b6ec7">operator=</a> (<a class="el" href="classripple_1_1Family.html">Family</a> &&)=delete</td></tr>
|
|
<tr class="separator:abb0c51695af2eda2cda16ca68c2b6ec7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af3c9358bb83bdee02793cef452c38f64"><td class="memItemLeft" align="right" valign="top"> </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"> </td></tr>
|
|
<tr class="memitem:acc97327a6e3f4e10783d397eebc9cbc0"><td class="memItemLeft" align="right" valign="top">virtual </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"> </td></tr>
|
|
<tr class="memitem:a2618f6f7bd3709acf853db111c814df2"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classripple_1_1NodeStore_1_1Database.html">NodeStore::Database</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#a2618f6f7bd3709acf853db111c814df2">db</a> ()=0</td></tr>
|
|
<tr class="separator:a2618f6f7bd3709acf853db111c814df2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ade80f185e1fd56bed3c2f073fc7508b1"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classripple_1_1NodeStore_1_1Database.html">NodeStore::Database</a> const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#ade80f185e1fd56bed3c2f073fc7508b1">db</a> () const =0</td></tr>
|
|
<tr class="separator:ade80f185e1fd56bed3c2f073fc7508b1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af25466995d0a740ffcf80cd8a59cf0c9"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#af25466995d0a740ffcf80cd8a59cf0c9">journal</a> ()=0</td></tr>
|
|
<tr class="separator:af25466995d0a740ffcf80cd8a59cf0c9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac16fa71cf792d5716da74e9164707769"><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>< <a class="el" href="namespaceripple.html#ad18fcbe19742d7f978f16f21ac70fba5">FullBelowCache</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#ac16fa71cf792d5716da74e9164707769">getFullBelowCache</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ledgerSeq)=0</td></tr>
|
|
<tr class="memdesc:ac16fa71cf792d5716da74e9164707769"><td class="mdescLeft"> </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#ac16fa71cf792d5716da74e9164707769">More...</a><br /></td></tr>
|
|
<tr class="separator:ac16fa71cf792d5716da74e9164707769"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a794019ebd9859fb37a7a65b80e8d6df7"><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>< <a class="el" href="namespaceripple.html#acffabb2b30913f9687dbf65f4afc0a19">TreeNodeCache</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#a794019ebd9859fb37a7a65b80e8d6df7">getTreeNodeCache</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ledgerSeq)=0</td></tr>
|
|
<tr class="memdesc:a794019ebd9859fb37a7a65b80e8d6df7"><td class="mdescLeft"> </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#a794019ebd9859fb37a7a65b80e8d6df7">More...</a><br /></td></tr>
|
|
<tr class="separator:a794019ebd9859fb37a7a65b80e8d6df7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3ad0cea735f2bd07adc7b5ed7b3528b8"><td class="memItemLeft" align="right" valign="top">virtual void </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"> </td></tr>
|
|
<tr class="memitem:a58104afed93195e1d2eb74c31dd514a8"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#a58104afed93195e1d2eb74c31dd514a8">isShardBacked</a> () const =0</td></tr>
|
|
<tr class="separator:a58104afed93195e1d2eb74c31dd514a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a195ad5c61d5ef6a5b269232ecea7ca55"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#a195ad5c61d5ef6a5b269232ecea7ca55">missingNode</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> refNum)=0</td></tr>
|
|
<tr class="separator:a195ad5c61d5ef6a5b269232ecea7ca55"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a25bd0bb37c0cbf82b50b479df990b5b2"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Family.html#a25bd0bb37c0cbf82b50b479df990b5b2">missingNode</a> (<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &refHash, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> refNum)=0</td></tr>
|
|
<tr class="separator:a25bd0bb37c0cbf82b50b479df990b5b2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2711e78e7c2e33e24db3dfa5235eccd4"><td class="memItemLeft" align="right" valign="top">virtual void </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"> </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 & Destructor Documentation</h2>
|
|
<a id="ad9c2be28150efd712386fb124ccfdeb9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad9c2be28150efd712386fb124ccfdeb9">◆ </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 & </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"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af6fe24bc981b9527af16ea1a1d531ab2">◆ </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> && </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"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af3c9358bb83bdee02793cef452c38f64">◆ </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"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acc97327a6e3f4e10783d397eebc9cbc0">◆ </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="a07ace65397c6fe5be9674420a8def04b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a07ace65397c6fe5be9674420a8def04b">◆ </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>& ripple::Family::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Family.html">Family</a> const & </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="abb0c51695af2eda2cda16ca68c2b6ec7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abb0c51695af2eda2cda16ca68c2b6ec7">◆ </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>& ripple::Family::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1Family.html">Family</a> && </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="a2618f6f7bd3709acf853db111c814df2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2618f6f7bd3709acf853db111c814df2">◆ </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>& 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#af27470cb06f50985c1f8b63d77f9ff7a">ripple::tests::TestNodeFamily</a>, <a class="el" href="classripple_1_1NodeFamily.html#ab3b5a3fc21e9d92baee91ad67ccce98e">ripple::NodeFamily</a>, and <a class="el" href="classripple_1_1ShardFamily.html#afb6dbe81c9305123f553ea4479c9f3fc">ripple::ShardFamily</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ade80f185e1fd56bed3c2f073fc7508b1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ade80f185e1fd56bed3c2f073fc7508b1">◆ </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& 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#a0a56415d5f3224683e3996fdcbe0ced1">ripple::tests::TestNodeFamily</a>, <a class="el" href="classripple_1_1NodeFamily.html#afbe4e51b92399e1665f4c16521d0db13">ripple::NodeFamily</a>, and <a class="el" href="classripple_1_1ShardFamily.html#a4c0171d2f38886d736977f79138bc5b1">ripple::ShardFamily</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af25466995d0a740ffcf80cd8a59cf0c9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af25466995d0a740ffcf80cd8a59cf0c9">◆ </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& 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#a71f0342c47e1f174830d66c7176f89f7">ripple::tests::TestNodeFamily</a>, <a class="el" href="classripple_1_1NodeFamily.html#a6c7379a762c7635f5d105ed7a7333525">ripple::NodeFamily</a>, and <a class="el" href="classripple_1_1ShardFamily.html#ab5de67b64594144e92610dbeef297677">ripple::ShardFamily</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac16fa71cf792d5716da74e9164707769"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac16fa71cf792d5716da74e9164707769">◆ </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><<a class="el" href="namespaceripple.html#ad18fcbe19742d7f978f16f21ac70fba5">FullBelowCache</a>> ripple::Family::getFullBelowCache </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> </td>
|
|
<td class="paramname"><em>ledgerSeq</em></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>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ledgerSeq</td><td>ledger sequence determines a corresponding shard cache </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>ledgerSeq is used by <a class="el" href="classripple_1_1ShardFamily.html">ShardFamily</a> and ignored by <a class="el" href="classripple_1_1NodeFamily.html">NodeFamily</a> </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1tests_1_1TestNodeFamily.html#a6afe860b96ac159f3dbd2ed2471ee978">ripple::tests::TestNodeFamily</a>, <a class="el" href="classripple_1_1NodeFamily.html#a09d13fbbcc85779a1dbd98251055f673">ripple::NodeFamily</a>, and <a class="el" href="classripple_1_1ShardFamily.html#ad23500cce22820d8aad188891443d123">ripple::ShardFamily</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a794019ebd9859fb37a7a65b80e8d6df7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a794019ebd9859fb37a7a65b80e8d6df7">◆ </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><<a class="el" href="namespaceripple.html#acffabb2b30913f9687dbf65f4afc0a19">TreeNodeCache</a>> ripple::Family::getTreeNodeCache </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> </td>
|
|
<td class="paramname"><em>ledgerSeq</em></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>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ledgerSeq</td><td>ledger sequence determines a corresponding shard cache </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>ledgerSeq is used by <a class="el" href="classripple_1_1ShardFamily.html">ShardFamily</a> and ignored by <a class="el" href="classripple_1_1NodeFamily.html">NodeFamily</a> </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classripple_1_1tests_1_1TestNodeFamily.html#aa54431728a29f6c71b555c7269e41cfa">ripple::tests::TestNodeFamily</a>, <a class="el" href="classripple_1_1NodeFamily.html#aa1488bd881c466dd7a8a37265f26ea56">ripple::NodeFamily</a>, and <a class="el" href="classripple_1_1ShardFamily.html#adc6a801e0955565a379da9e0abd6fe82">ripple::ShardFamily</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3ad0cea735f2bd07adc7b5ed7b3528b8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3ad0cea735f2bd07adc7b5ed7b3528b8">◆ </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>, <a class="el" href="classripple_1_1ShardFamily.html#a7d20553d0c7fb3f3ecf4e630058dc260">ripple::ShardFamily</a>, and <a class="el" href="classripple_1_1NodeFamily.html#a656e8cb2fa08a2f5549c9b42228b5d57">ripple::NodeFamily</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a58104afed93195e1d2eb74c31dd514a8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a58104afed93195e1d2eb74c31dd514a8">◆ </a></span>isShardBacked()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool ripple::Family::isShardBacked </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#afb023f84c09e43f20e2c5c802ac89398">ripple::tests::TestNodeFamily</a>, <a class="el" href="classripple_1_1NodeFamily.html#a82cca89d34928fbbf56dcd65ab84a25f">ripple::NodeFamily</a>, and <a class="el" href="classripple_1_1ShardFamily.html#a4f9541f753bbbda3c758b882f39f1155">ripple::ShardFamily</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a195ad5c61d5ef6a5b269232ecea7ca55"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a195ad5c61d5ef6a5b269232ecea7ca55">◆ </a></span>missingNode() <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 void ripple::Family::missingNode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> </td>
|
|
<td class="paramname"><em>refNum</em></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_1ShardFamily.html#ab8a8537a986b8ba0ca4f556c065d669c">ripple::ShardFamily</a>, <a class="el" href="classripple_1_1NodeFamily.html#ae28638a42e0a37921b85da75d6d73ba3">ripple::NodeFamily</a>, and <a class="el" href="classripple_1_1tests_1_1TestNodeFamily.html#a8f177b952248943dee2c55f8fd780844">ripple::tests::TestNodeFamily</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a25bd0bb37c0cbf82b50b479df990b5b2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a25bd0bb37c0cbf82b50b479df990b5b2">◆ </a></span>missingNode() <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 void ripple::Family::missingNode </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const & </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> </td>
|
|
<td class="paramname"><em>refNum</em> </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>Implemented in <a class="el" href="classripple_1_1tests_1_1TestNodeFamily.html#a245a544cb00a81ee4378703d696294f2">ripple::tests::TestNodeFamily</a>, <a class="el" href="classripple_1_1ShardFamily.html#ab37342166bcf5823ea87e1b7bb6f54b3">ripple::ShardFamily</a>, and <a class="el" href="classripple_1_1NodeFamily.html#aa104bf159439bb227ae4b2ae1afc9231">ripple::NodeFamily</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2711e78e7c2e33e24db3dfa5235eccd4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2711e78e7c2e33e24db3dfa5235eccd4">◆ </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>, <a class="el" href="classripple_1_1ShardFamily.html#abc32123f94ee1177fa3a1fd5dfe1c982">ripple::ShardFamily</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  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|