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_1detail_1_1BasicFullBelowCache.html
bthomee e61ca37029 deploy: eac3abdca9
2025-01-21 19:58:08 +00:00

558 lines
35 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::detail::BasicFullBelowCache 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="namespaceripple_1_1detail.html">detail</a></li><li class="navelem"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html">BasicFullBelowCache</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-types">Private Types</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1detail_1_1BasicFullBelowCache-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::detail::BasicFullBelowCache Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Remembers which tree keys have all descendants resident.
<a href="classripple_1_1detail_1_1BasicFullBelowCache.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::detail::BasicFullBelowCache:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1detail_1_1BasicFullBelowCache__coll__graph.png" border="0" usemap="#aripple_1_1detail_1_1BasicFullBelowCache_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1detail_1_1BasicFullBelowCache_coll__map" id="aripple_1_1detail_1_1BasicFullBelowCache_coll__map">
<area shape="rect" title="Remembers which tree keys have all descendants resident." alt="" coords="1697,357,1868,397"/>
<area shape="rect" href="classripple_1_1TaggedCache.html" title="Map/cache combination." alt="" coords="1388,273,1579,327"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="1119,7,1230,33"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="799,7,945,33"/>
<area shape="rect" href="classbeast_1_1abstract__clock.html" title="Abstract interface to a clock." alt="" coords="1095,57,1255,97"/>
<area shape="rect" href="structripple_1_1TaggedCache_1_1Stats.html" title=" " alt="" coords="1087,121,1263,191"/>
<area shape="rect" href="classbeast_1_1insight_1_1Hook.html" title="A reference to a handler for performing polled collection." alt="" coords="796,78,948,103"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="507,69,677,109"/>
<area shape="rect" href="classbeast_1_1insight_1_1HookImpl.html" title=" " alt="" coords="251,77,432,102"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html" title=" " alt="" coords="9,69,193,109"/>
<area shape="rect" href="classbeast_1_1insight_1_1Gauge.html" title="A metric for measuring an integral value." alt="" coords="792,141,952,166"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="507,133,677,173"/>
<area shape="rect" href="classbeast_1_1insight_1_1GaugeImpl.html" title=" " alt="" coords="247,141,436,166"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html" title=" " alt="" coords="5,133,197,173"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="828,219,916,245"/>
<area shape="rect" href="classripple_1_1partitioned__unordered__map.html" title=" " alt="" coords="1087,215,1262,299"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html" title=" " alt="" coords="1095,323,1254,349"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="1131,373,1218,398"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="803,365,941,405"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="779,290,965,315"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="1123,422,1226,447"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="1380,397,1587,422"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="1123,471,1226,497"/>
</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-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a4380772c4e787779ebc4f7e7da9f23b7"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a4380772c4e787779ebc4f7e7da9f23b7adbd74677e86b456da79f7220ac9608b7">defaultCacheTargetSize</a> = 0
}</td></tr>
<tr class="separator:a4380772c4e787779ebc4f7e7da9f23b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a996417838ff4976b0a5f0ab282d077"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a2a996417838ff4976b0a5f0ab282d077">key_type</a> = <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a></td></tr>
<tr class="separator:a2a996417838ff4976b0a5f0ab282d077"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a423a681101740aa7435513958052b80a"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a423a681101740aa7435513958052b80a">clock_type</a> = typename <a class="el" href="classripple_1_1TaggedCache.html#ac55d64946c1478480a16538eea72b0d0">CacheType::clock_type</a></td></tr>
<tr class="separator:a423a681101740aa7435513958052b80a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a3d21ea49453f49bc15325304862888fc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a3d21ea49453f49bc15325304862888fc">BasicFullBelowCache</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;name, <a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a423a681101740aa7435513958052b80a">clock_type</a> &amp;<a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a6d8674350441715076cb2ea74392d559">clock</a>, <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> j, <a class="el" href="classbeast_1_1insight_1_1Collector.html#ad1677ecd39a09b6a8bb8f2e073266bc4">beast::insight::Collector::ptr</a> const &amp;collector=<a class="el" href="classbeast_1_1insight_1_1NullCollector.html#a8821f08e6db108aacae400a738286da6">beast::insight::NullCollector::New</a>(), <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> target_size=<a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a4380772c4e787779ebc4f7e7da9f23b7adbd74677e86b456da79f7220ac9608b7">defaultCacheTargetSize</a>, <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a> expiration=<a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::minutes</a>{2})</td></tr>
<tr class="memdesc:a3d21ea49453f49bc15325304862888fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the cache. <a href="classripple_1_1detail_1_1BasicFullBelowCache.html#a3d21ea49453f49bc15325304862888fc">More...</a><br /></td></tr>
<tr class="separator:a3d21ea49453f49bc15325304862888fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d8674350441715076cb2ea74392d559"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a423a681101740aa7435513958052b80a">clock_type</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a6d8674350441715076cb2ea74392d559">clock</a> ()</td></tr>
<tr class="memdesc:a6d8674350441715076cb2ea74392d559"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the clock associated with the cache. <a href="classripple_1_1detail_1_1BasicFullBelowCache.html#a6d8674350441715076cb2ea74392d559">More...</a><br /></td></tr>
<tr class="separator:a6d8674350441715076cb2ea74392d559"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1117cea7372360e2dd4ca057fab4ce6"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#ac1117cea7372360e2dd4ca057fab4ce6">size</a> () const</td></tr>
<tr class="memdesc:ac1117cea7372360e2dd4ca057fab4ce6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the number of elements in the cache. <a href="classripple_1_1detail_1_1BasicFullBelowCache.html#ac1117cea7372360e2dd4ca057fab4ce6">More...</a><br /></td></tr>
<tr class="separator:ac1117cea7372360e2dd4ca057fab4ce6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39e7b4fe588f2d33e7f18204eaf3590c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a39e7b4fe588f2d33e7f18204eaf3590c">sweep</a> ()</td></tr>
<tr class="memdesc:a39e7b4fe588f2d33e7f18204eaf3590c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove expired cache items. <a href="classripple_1_1detail_1_1BasicFullBelowCache.html#a39e7b4fe588f2d33e7f18204eaf3590c">More...</a><br /></td></tr>
<tr class="separator:a39e7b4fe588f2d33e7f18204eaf3590c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab51f01e912288d8bd3fce87177815c7e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#ab51f01e912288d8bd3fce87177815c7e">touch_if_exists</a> (<a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a2a996417838ff4976b0a5f0ab282d077">key_type</a> const &amp;key)</td></tr>
<tr class="memdesc:ab51f01e912288d8bd3fce87177815c7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Refresh the last access time of an item, if it exists. <a href="classripple_1_1detail_1_1BasicFullBelowCache.html#ab51f01e912288d8bd3fce87177815c7e">More...</a><br /></td></tr>
<tr class="separator:ab51f01e912288d8bd3fce87177815c7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bef3798b312f0a3daf00c8c7fa20133"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a2bef3798b312f0a3daf00c8c7fa20133">insert</a> (<a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a2a996417838ff4976b0a5f0ab282d077">key_type</a> const &amp;key)</td></tr>
<tr class="memdesc:a2bef3798b312f0a3daf00c8c7fa20133"><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert a key into the cache. <a href="classripple_1_1detail_1_1BasicFullBelowCache.html#a2bef3798b312f0a3daf00c8c7fa20133">More...</a><br /></td></tr>
<tr class="separator:a2bef3798b312f0a3daf00c8c7fa20133"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80e58b4c620ff5079cc4591525bf8847"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a80e58b4c620ff5079cc4591525bf8847">getGeneration</a> (void) const</td></tr>
<tr class="memdesc:a80e58b4c620ff5079cc4591525bf8847"><td class="mdescLeft">&#160;</td><td class="mdescRight">generation determines whether cached entry is valid <a href="classripple_1_1detail_1_1BasicFullBelowCache.html#a80e58b4c620ff5079cc4591525bf8847">More...</a><br /></td></tr>
<tr class="separator:a80e58b4c620ff5079cc4591525bf8847"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1eb786c83738b635b56c67ecadcd033"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#ad1eb786c83738b635b56c67ecadcd033">clear</a> ()</td></tr>
<tr class="separator:ad1eb786c83738b635b56c67ecadcd033"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a114c0f8772cc05647c76f9ade209247e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a114c0f8772cc05647c76f9ade209247e">reset</a> ()</td></tr>
<tr class="separator:a114c0f8772cc05647c76f9ade209247e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-types" name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:afa52468a09a96dd41eebfaf17d26b4a2"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#afa52468a09a96dd41eebfaf17d26b4a2">CacheType</a> = <a class="el" href="namespaceripple.html#a979e8d8bf61cdf2a37f13aa2e7ed906e">KeyCache</a></td></tr>
<tr class="separator:afa52468a09a96dd41eebfaf17d26b4a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:adfb9616e765ce47eace5122a3b91ade0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#afa52468a09a96dd41eebfaf17d26b4a2">CacheType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#adfb9616e765ce47eace5122a3b91ade0">m_cache</a></td></tr>
<tr class="separator:adfb9616e765ce47eace5122a3b91ade0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a123fad3c1db1d53b75c3b64f4fff9790"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a123fad3c1db1d53b75c3b64f4fff9790">m_gen</a></td></tr>
<tr class="separator:a123fad3c1db1d53b75c3b64f4fff9790"><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 >Remembers which tree keys have all descendants resident. </p>
<p >This optimizes the process of acquiring a complete tree. </p>
<p class="definition">Definition at line <a class="el" href="FullBelowCache_8h_source.html#l00038">38</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="afa52468a09a96dd41eebfaf17d26b4a2" name="afa52468a09a96dd41eebfaf17d26b4a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa52468a09a96dd41eebfaf17d26b4a2">&#9670;&#160;</a></span>CacheType</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#afa52468a09a96dd41eebfaf17d26b4a2">ripple::detail::BasicFullBelowCache::CacheType</a> = <a class="el" href="namespaceripple.html#a979e8d8bf61cdf2a37f13aa2e7ed906e">KeyCache</a></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="FullBelowCache_8h_source.html#l00041">41</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<a id="a2a996417838ff4976b0a5f0ab282d077" name="a2a996417838ff4976b0a5f0ab282d077"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a996417838ff4976b0a5f0ab282d077">&#9670;&#160;</a></span>key_type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a2a996417838ff4976b0a5f0ab282d077">ripple::detail::BasicFullBelowCache::key_type</a> = <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="FullBelowCache_8h_source.html#l00046">46</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<a id="a423a681101740aa7435513958052b80a" name="a423a681101740aa7435513958052b80a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a423a681101740aa7435513958052b80a">&#9670;&#160;</a></span>clock_type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a423a681101740aa7435513958052b80a">ripple::detail::BasicFullBelowCache::clock_type</a> = typename <a class="el" href="classripple_1_1TaggedCache.html#ac55d64946c1478480a16538eea72b0d0">CacheType::clock_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="FullBelowCache_8h_source.html#l00047">47</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a4380772c4e787779ebc4f7e7da9f23b7" name="a4380772c4e787779ebc4f7e7da9f23b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4380772c4e787779ebc4f7e7da9f23b7">&#9670;&#160;</a></span>anonymous enum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a4380772c4e787779ebc4f7e7da9f23b7adbd74677e86b456da79f7220ac9608b7" name="a4380772c4e787779ebc4f7e7da9f23b7adbd74677e86b456da79f7220ac9608b7"></a>defaultCacheTargetSize&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="FullBelowCache_8h_source.html#l00044">44</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3d21ea49453f49bc15325304862888fc" name="a3d21ea49453f49bc15325304862888fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d21ea49453f49bc15325304862888fc">&#9670;&#160;</a></span>BasicFullBelowCache()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::detail::BasicFullBelowCache::BasicFullBelowCache </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a423a681101740aa7435513958052b80a">clock_type</a> &amp;&#160;</td>
<td class="paramname"><em>clock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td>
<td class="paramname"><em>j</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classbeast_1_1insight_1_1Collector.html#ad1677ecd39a09b6a8bb8f2e073266bc4">beast::insight::Collector::ptr</a> const &amp;&#160;</td>
<td class="paramname"><em>collector</em> = <code><a class="el" href="classbeast_1_1insight_1_1NullCollector.html#a8821f08e6db108aacae400a738286da6">beast::insight::NullCollector::New</a>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td>
<td class="paramname"><em>target_size</em> = <code><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a4380772c4e787779ebc4f7e7da9f23b7adbd74677e86b456da79f7220ac9608b7">defaultCacheTargetSize</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::seconds</a>&#160;</td>
<td class="paramname"><em>expiration</em> = <code><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::minutes</a>{2}</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct the cache. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>A label for diagnostics and stats reporting. </td></tr>
<tr><td class="paramname">collector</td><td>The collector to use for reporting stats. </td></tr>
<tr><td class="paramname">targetSize</td><td>The cache target size. </td></tr>
<tr><td class="paramname">targetExpirationSeconds</td><td>The expiration time for items. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="FullBelowCache_8h_source.html#l00056">56</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6d8674350441715076cb2ea74392d559" name="a6d8674350441715076cb2ea74392d559"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d8674350441715076cb2ea74392d559">&#9670;&#160;</a></span>clock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a423a681101740aa7435513958052b80a">clock_type</a> &amp; ripple::detail::BasicFullBelowCache::clock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the clock associated with the cache. </p>
<p class="definition">Definition at line <a class="el" href="FullBelowCache_8h_source.html#l00070">70</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<a id="ac1117cea7372360e2dd4ca057fab4ce6" name="ac1117cea7372360e2dd4ca057fab4ce6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1117cea7372360e2dd4ca057fab4ce6">&#9670;&#160;</a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> ripple::detail::BasicFullBelowCache::size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the number of elements in the cache. </p>
<p >Thread safety: Safe to call from any thread. </p>
<p class="definition">Definition at line <a class="el" href="FullBelowCache_8h_source.html#l00080">80</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<a id="a39e7b4fe588f2d33e7f18204eaf3590c" name="a39e7b4fe588f2d33e7f18204eaf3590c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39e7b4fe588f2d33e7f18204eaf3590c">&#9670;&#160;</a></span>sweep()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::detail::BasicFullBelowCache::sweep </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove expired cache items. </p>
<p >Thread safety: Safe to call from any thread. </p>
<p class="definition">Definition at line <a class="el" href="FullBelowCache_8h_source.html#l00090">90</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<a id="ab51f01e912288d8bd3fce87177815c7e" name="ab51f01e912288d8bd3fce87177815c7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab51f01e912288d8bd3fce87177815c7e">&#9670;&#160;</a></span>touch_if_exists()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::detail::BasicFullBelowCache::touch_if_exists </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a2a996417838ff4976b0a5f0ab282d077">key_type</a> const &amp;&#160;</td>
<td class="paramname"><em>key</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Refresh the last access time of an item, if it exists. </p>
<p >Thread safety: Safe to call from any thread. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>The key to refresh. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> If the key exists. </dd></dl>
<p class="definition">Definition at line <a class="el" href="FullBelowCache_8h_source.html#l00102">102</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<a id="a2bef3798b312f0a3daf00c8c7fa20133" name="a2bef3798b312f0a3daf00c8c7fa20133"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2bef3798b312f0a3daf00c8c7fa20133">&#9670;&#160;</a></span>insert()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::detail::BasicFullBelowCache::insert </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a2a996417838ff4976b0a5f0ab282d077">key_type</a> const &amp;&#160;</td>
<td class="paramname"><em>key</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Insert a key into the cache. </p>
<p >If the key already exists, the last access time will still be refreshed. Thread safety: Safe to call from any thread. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>The key to insert. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="FullBelowCache_8h_source.html#l00115">115</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<a id="a80e58b4c620ff5079cc4591525bf8847" name="a80e58b4c620ff5079cc4591525bf8847"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80e58b4c620ff5079cc4591525bf8847">&#9670;&#160;</a></span>getGeneration()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ripple::detail::BasicFullBelowCache::getGeneration </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>generation determines whether cached entry is valid </p>
<p class="definition">Definition at line <a class="el" href="FullBelowCache_8h_source.html#l00122">122</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<a id="ad1eb786c83738b635b56c67ecadcd033" name="ad1eb786c83738b635b56c67ecadcd033"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1eb786c83738b635b56c67ecadcd033">&#9670;&#160;</a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::detail::BasicFullBelowCache::clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="FullBelowCache_8h_source.html#l00128">128</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<a id="a114c0f8772cc05647c76f9ade209247e" name="a114c0f8772cc05647c76f9ade209247e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a114c0f8772cc05647c76f9ade209247e">&#9670;&#160;</a></span>reset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::detail::BasicFullBelowCache::reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="FullBelowCache_8h_source.html#l00135">135</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="adfb9616e765ce47eace5122a3b91ade0" name="adfb9616e765ce47eace5122a3b91ade0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfb9616e765ce47eace5122a3b91ade0">&#9670;&#160;</a></span>m_cache</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_1detail_1_1BasicFullBelowCache.html#afa52468a09a96dd41eebfaf17d26b4a2">CacheType</a> ripple::detail::BasicFullBelowCache::m_cache</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="FullBelowCache_8h_source.html#l00142">142</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<a id="a123fad3c1db1d53b75c3b64f4fff9790" name="a123fad3c1db1d53b75c3b64f4fff9790"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a123fad3c1db1d53b75c3b64f4fff9790">&#9670;&#160;</a></span>m_gen</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/atomic/atomic.html">std::atomic</a>&lt;<a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>&gt; ripple::detail::BasicFullBelowCache::m_gen</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="FullBelowCache_8h_source.html#l00143">143</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</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