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
430f6c0cf30efed4bcac2c5911b135ced6b7a7ae
rippled/classripple_1_1detail_1_1BasicFullBelowCache.html
manojsdoshi 430f6c0cf3 deploy: 023f5704d0
2020-04-24 01:09:47 +00:00

593 lines
37 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">
<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::detail::BasicFullBelowCache&lt; Key &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="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&lt; Key &gt; Class Template 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>
<div class="dynheader">
Collaboration diagram for ripple::detail::BasicFullBelowCache&lt; Key &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1detail_1_1BasicFullBelowCache__coll__graph.png" border="0" usemap="#ripple_1_1detail_1_1BasicFullBelowCache_3_01Key_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1detail_1_1BasicFullBelowCache_3_01Key_01_4_coll__map" id="ripple_1_1detail_1_1BasicFullBelowCache_3_01Key_01_4_coll__map">
<area shape="rect" title="Remembers which tree keys have all descendants resident." alt="" coords="1716,257,1885,298"/>
<area shape="rect" href="classripple_1_1KeyCache.html" title=" " alt="" coords="1409,213,1595,240"/>
<area shape="rect" href="classbeast_1_1abstract__clock.html" title=" " alt="" coords="1082,5,1243,61"/>
<area shape="rect" href="structripple_1_1KeyCache_1_1Stats.html" title=" " alt="" coords="1075,85,1250,141"/>
<area shape="rect" href="classbeast_1_1insight_1_1Gauge.html" title="A metric for measuring an integral value." alt="" coords="779,51,939,77"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="507,38,677,79"/>
<area shape="rect" href="classbeast_1_1insight_1_1GaugeImpl.html" title=" " alt="" coords="247,45,436,72"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html" title=" " alt="" coords="5,38,197,79"/>
<area shape="rect" href="classbeast_1_1insight_1_1Hook.html" title="A reference to a handler for performing polled collection." alt="" coords="783,103,935,129"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="507,103,677,145"/>
<area shape="rect" href="classbeast_1_1insight_1_1HookImpl.html" title=" " alt="" coords="251,111,432,137"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html" title=" " alt="" coords="9,103,193,145"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="815,160,903,187"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="1041,165,1284,221"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/mutex.html" title="STL class." alt="" coords="1117,245,1209,272"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title="STL class." alt="" coords="1119,296,1206,323"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="1399,289,1605,316"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="1111,347,1214,373"/>
</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-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#a4380772c4e787779ebc4f7e7da9f23b7ae10ce03f09b314faadeff8cff304c326">defaultCacheTargetSize</a> = 0
}</td></tr>
<tr class="separator:a4380772c4e787779ebc4f7e7da9f23b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af834351ef2de493fa8077fad69f63608"><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#af834351ef2de493fa8077fad69f63608">key_type</a> = Key</td></tr>
<tr class="separator:af834351ef2de493fa8077fad69f63608"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae7b2e296d6e1572c20fad56bc9aba31"><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#aae7b2e296d6e1572c20fad56bc9aba31">size_type</a> = typename <a class="el" href="classripple_1_1KeyCache.html#a27ffdc83af477dfc719054907918a148">CacheType::size_type</a></td></tr>
<tr class="separator:aae7b2e296d6e1572c20fad56bc9aba31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75bf1d68ac90ebc1163e8e6bd0568752"><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#a75bf1d68ac90ebc1163e8e6bd0568752">clock_type</a> = typename <a class="el" href="classripple_1_1KeyCache.html#a08e89647e3c3229104230c925433920d">CacheType::clock_type</a></td></tr>
<tr class="separator:a75bf1d68ac90ebc1163e8e6bd0568752"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a6cdb5c5c5ec9f0e77685ae8413cbb4cc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a6cdb5c5c5ec9f0e77685ae8413cbb4cc">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#a75bf1d68ac90ebc1163e8e6bd0568752">clock_type</a> &amp;<a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a11d4cb29d2faa05a9f737e9a77c375dc">clock</a>, <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#a4380772c4e787779ebc4f7e7da9f23b7ae10ce03f09b314faadeff8cff304c326">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:a6cdb5c5c5ec9f0e77685ae8413cbb4cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the cache. <a href="classripple_1_1detail_1_1BasicFullBelowCache.html#a6cdb5c5c5ec9f0e77685ae8413cbb4cc">More...</a><br /></td></tr>
<tr class="separator:a6cdb5c5c5ec9f0e77685ae8413cbb4cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11d4cb29d2faa05a9f737e9a77c375dc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a75bf1d68ac90ebc1163e8e6bd0568752">clock_type</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a11d4cb29d2faa05a9f737e9a77c375dc">clock</a> ()</td></tr>
<tr class="memdesc:a11d4cb29d2faa05a9f737e9a77c375dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the clock associated with the cache. <a href="classripple_1_1detail_1_1BasicFullBelowCache.html#a11d4cb29d2faa05a9f737e9a77c375dc">More...</a><br /></td></tr>
<tr class="separator:a11d4cb29d2faa05a9f737e9a77c375dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d15ae999cbf512e349a9b9c9116359b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#aae7b2e296d6e1572c20fad56bc9aba31">size_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a2d15ae999cbf512e349a9b9c9116359b">size</a> () const</td></tr>
<tr class="memdesc:a2d15ae999cbf512e349a9b9c9116359b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the number of elements in the cache. <a href="classripple_1_1detail_1_1BasicFullBelowCache.html#a2d15ae999cbf512e349a9b9c9116359b">More...</a><br /></td></tr>
<tr class="separator:a2d15ae999cbf512e349a9b9c9116359b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc3d54fc0e19eb02dfb80cb16b46a61c"><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#abc3d54fc0e19eb02dfb80cb16b46a61c">sweep</a> ()</td></tr>
<tr class="memdesc:abc3d54fc0e19eb02dfb80cb16b46a61c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove expired cache items. <a href="classripple_1_1detail_1_1BasicFullBelowCache.html#abc3d54fc0e19eb02dfb80cb16b46a61c">More...</a><br /></td></tr>
<tr class="separator:abc3d54fc0e19eb02dfb80cb16b46a61c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e207e81c6878a8d26e48c8fdaad5859"><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#a5e207e81c6878a8d26e48c8fdaad5859">touch_if_exists</a> (<a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#af834351ef2de493fa8077fad69f63608">key_type</a> const &amp;key)</td></tr>
<tr class="memdesc:a5e207e81c6878a8d26e48c8fdaad5859"><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#a5e207e81c6878a8d26e48c8fdaad5859">More...</a><br /></td></tr>
<tr class="separator:a5e207e81c6878a8d26e48c8fdaad5859"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6344198691e605702d23eba86a3177b2"><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#a6344198691e605702d23eba86a3177b2">insert</a> (<a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#af834351ef2de493fa8077fad69f63608">key_type</a> const &amp;key)</td></tr>
<tr class="memdesc:a6344198691e605702d23eba86a3177b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert a key into the cache. <a href="classripple_1_1detail_1_1BasicFullBelowCache.html#a6344198691e605702d23eba86a3177b2">More...</a><br /></td></tr>
<tr class="separator:a6344198691e605702d23eba86a3177b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24dcba9ab4a873d9d002a903585fff45"><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#a24dcba9ab4a873d9d002a903585fff45">getGeneration</a> (void) const</td></tr>
<tr class="memdesc:a24dcba9ab4a873d9d002a903585fff45"><td class="mdescLeft">&#160;</td><td class="mdescRight">generation determines whether cached entry is valid <a href="classripple_1_1detail_1_1BasicFullBelowCache.html#a24dcba9ab4a873d9d002a903585fff45">More...</a><br /></td></tr>
<tr class="separator:a24dcba9ab4a873d9d002a903585fff45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab848d9b7735bd22c13ce05478c322aca"><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#ab848d9b7735bd22c13ce05478c322aca">clear</a> ()</td></tr>
<tr class="separator:ab848d9b7735bd22c13ce05478c322aca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5901f72842fa510c191e2ebecc366920"><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#a5901f72842fa510c191e2ebecc366920">reset</a> ()</td></tr>
<tr class="separator:a5901f72842fa510c191e2ebecc366920"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:a053001dc20690a3c54616fe8f3fea843"><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#a053001dc20690a3c54616fe8f3fea843">CacheType</a> = <a class="el" href="classripple_1_1KeyCache.html">KeyCache</a>&lt; Key &gt;</td></tr>
<tr class="separator:a053001dc20690a3c54616fe8f3fea843"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a45cf80eb5c726d631eeebf77bfd3ae78"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1KeyCache.html">KeyCache</a>&lt; Key &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a45cf80eb5c726d631eeebf77bfd3ae78">m_cache</a></td></tr>
<tr class="separator:a45cf80eb5c726d631eeebf77bfd3ae78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02f7ec259bbd5a7e2a427403a312b69f"><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#a02f7ec259bbd5a7e2a427403a312b69f">m_gen</a></td></tr>
<tr class="separator:a02f7ec259bbd5a7e2a427403a312b69f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class Key&gt;<br />
class ripple::detail::BasicFullBelowCache&lt; Key &gt;</h3>
<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#l00037">37</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="a053001dc20690a3c54616fe8f3fea843"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a053001dc20690a3c54616fe8f3fea843">&#9670;&nbsp;</a></span>CacheType</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Key &gt; </div>
<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">ripple::detail::BasicFullBelowCache</a>&lt; Key &gt;::<a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a053001dc20690a3c54616fe8f3fea843">CacheType</a> = <a class="el" href="classripple_1_1KeyCache.html">KeyCache</a>&lt;Key&gt;</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#l00040">40</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<a id="af834351ef2de493fa8077fad69f63608"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af834351ef2de493fa8077fad69f63608">&#9670;&nbsp;</a></span>key_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Key &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html">ripple::detail::BasicFullBelowCache</a>&lt; Key &gt;::<a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#af834351ef2de493fa8077fad69f63608">key_type</a> = Key</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="FullBelowCache_8h_source.html#l00045">45</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<a id="aae7b2e296d6e1572c20fad56bc9aba31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae7b2e296d6e1572c20fad56bc9aba31">&#9670;&nbsp;</a></span>size_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Key &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html">ripple::detail::BasicFullBelowCache</a>&lt; Key &gt;::<a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#aae7b2e296d6e1572c20fad56bc9aba31">size_type</a> = typename <a class="el" href="classripple_1_1KeyCache.html#a27ffdc83af477dfc719054907918a148">CacheType::size_type</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="a75bf1d68ac90ebc1163e8e6bd0568752"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75bf1d68ac90ebc1163e8e6bd0568752">&#9670;&nbsp;</a></span>clock_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Key &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html">ripple::detail::BasicFullBelowCache</a>&lt; Key &gt;::<a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a75bf1d68ac90ebc1163e8e6bd0568752">clock_type</a> = typename <a class="el" href="classripple_1_1KeyCache.html#a08e89647e3c3229104230c925433920d">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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4380772c4e787779ebc4f7e7da9f23b7">&#9670;&nbsp;</a></span>anonymous enum</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Key &gt; </div>
<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="a4380772c4e787779ebc4f7e7da9f23b7ae10ce03f09b314faadeff8cff304c326"></a>defaultCacheTargetSize&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="FullBelowCache_8h_source.html#l00043">43</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="a6cdb5c5c5ec9f0e77685ae8413cbb4cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6cdb5c5c5ec9f0e77685ae8413cbb4cc">&#9670;&nbsp;</a></span>BasicFullBelowCache()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Key &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html">ripple::detail::BasicFullBelowCache</a>&lt; Key &gt;::<a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html">BasicFullBelowCache</a> </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#a75bf1d68ac90ebc1163e8e6bd0568752">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_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#a4380772c4e787779ebc4f7e7da9f23b7ae10ce03f09b314faadeff8cff304c326">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="a11d4cb29d2faa05a9f737e9a77c375dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11d4cb29d2faa05a9f737e9a77c375dc">&#9670;&nbsp;</a></span>clock()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Key &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#a75bf1d68ac90ebc1163e8e6bd0568752">clock_type</a>&amp; <a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html">ripple::detail::BasicFullBelowCache</a>&lt; Key &gt;::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#l00069">69</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<a id="a2d15ae999cbf512e349a9b9c9116359b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d15ae999cbf512e349a9b9c9116359b">&#9670;&nbsp;</a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Key &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#aae7b2e296d6e1572c20fad56bc9aba31">size_type</a> <a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html">ripple::detail::BasicFullBelowCache</a>&lt; Key &gt;::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#l00079">79</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<a id="abc3d54fc0e19eb02dfb80cb16b46a61c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc3d54fc0e19eb02dfb80cb16b46a61c">&#9670;&nbsp;</a></span>sweep()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Key &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html">ripple::detail::BasicFullBelowCache</a>&lt; Key &gt;::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#l00089">89</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<a id="a5e207e81c6878a8d26e48c8fdaad5859"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e207e81c6878a8d26e48c8fdaad5859">&#9670;&nbsp;</a></span>touch_if_exists()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Key &gt; </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html">ripple::detail::BasicFullBelowCache</a>&lt; Key &gt;::touch_if_exists </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#af834351ef2de493fa8077fad69f63608">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#l00101">101</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<a id="a6344198691e605702d23eba86a3177b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6344198691e605702d23eba86a3177b2">&#9670;&nbsp;</a></span>insert()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Key &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html">ripple::detail::BasicFullBelowCache</a>&lt; Key &gt;::insert </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html#af834351ef2de493fa8077fad69f63608">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#l00114">114</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<a id="a24dcba9ab4a873d9d002a903585fff45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24dcba9ab4a873d9d002a903585fff45">&#9670;&nbsp;</a></span>getGeneration()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Key &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> <a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html">ripple::detail::BasicFullBelowCache</a>&lt; Key &gt;::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#l00121">121</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<a id="ab848d9b7735bd22c13ce05478c322aca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab848d9b7735bd22c13ce05478c322aca">&#9670;&nbsp;</a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Key &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html">ripple::detail::BasicFullBelowCache</a>&lt; Key &gt;::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#l00127">127</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<a id="a5901f72842fa510c191e2ebecc366920"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5901f72842fa510c191e2ebecc366920">&#9670;&nbsp;</a></span>reset()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Key &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html">ripple::detail::BasicFullBelowCache</a>&lt; Key &gt;::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#l00134">134</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="a45cf80eb5c726d631eeebf77bfd3ae78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45cf80eb5c726d631eeebf77bfd3ae78">&#9670;&nbsp;</a></span>m_cache</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Key &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1KeyCache.html">KeyCache</a>&lt;Key&gt; <a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html">ripple::detail::BasicFullBelowCache</a>&lt; Key &gt;::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#l00141">141</a> of file <a class="el" href="FullBelowCache_8h_source.html">FullBelowCache.h</a>.</p>
</div>
</div>
<a id="a02f7ec259bbd5a7e2a427403a312b69f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02f7ec259bbd5a7e2a427403a312b69f">&#9670;&nbsp;</a></span>m_gen</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Key &gt; </div>
<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; <a class="el" href="classripple_1_1detail_1_1BasicFullBelowCache.html">ripple::detail::BasicFullBelowCache</a>&lt; Key &gt;::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#l00142">142</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="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink