blob: 42b29323804e6ae99dd87e142d026a69081a7d19 [file]
<!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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Paimon-cpp: paimon::CacheValue 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">Paimon-cpp
</div>
<div id="projectbrief">A high-performance C++ implementation of Apache Paimon</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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="namespacepaimon.html">paimon</a></li><li class="navelem"><a class="el" href="classpaimon_1_1_cache_value.html">CacheValue</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classpaimon_1_1_cache_value-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">paimon::CacheValue Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="cache_8h_source.html">/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/cache/cache.h</a>&gt;</code></p>
<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:a20590cf803d6bb4ed0ed707ec7382694" id="r_a20590cf803d6bb4ed0ed707ec7382694"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_cache_value.html#a20590cf803d6bb4ed0ed707ec7382694">CacheValue</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="classpaimon_1_1_memory_segment.html">MemorySegment</a> &amp;<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">segment</a>, <a class="el" href="namespacepaimon.html#a9964a294431d6d8c0d6ac26a7a8fc7df">CacheCallback</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">callback</a>)</td></tr>
<tr class="separator:a20590cf803d6bb4ed0ed707ec7382694"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af094fb7bbbc3d2a9fdea773febe3aace" id="r_af094fb7bbbc3d2a9fdea773febe3aace"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_cache_value.html#af094fb7bbbc3d2a9fdea773febe3aace">~CacheValue</a> ()</td></tr>
<tr class="separator:af094fb7bbbc3d2a9fdea773febe3aace"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07777a1933981e988d3eaae040725691" id="r_a07777a1933981e988d3eaae040725691"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="classpaimon_1_1_memory_segment.html">MemorySegment</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_cache_value.html#a07777a1933981e988d3eaae040725691">GetSegment</a> () <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr>
<tr class="separator:a07777a1933981e988d3eaae040725691"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa72715705a5cef8c7582ab2ae43d6fc3" id="r_aa72715705a5cef8c7582ab2ae43d6fc3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_cache_value.html#aa72715705a5cef8c7582ab2ae43d6fc3">OnEvict</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr&lt; <a class="el" href="classpaimon_1_1_cache_key.html">CacheKey</a> &gt; &amp;<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">key</a>) <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr>
<tr class="separator:aa72715705a5cef8c7582ab2ae43d6fc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac75e4c70aef55fde8f257b843dd5f28f" id="r_ac75e4c70aef55fde8f257b843dd5f28f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_cache_value.html#ac75e4c70aef55fde8f257b843dd5f28f">operator==</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="classpaimon_1_1_cache_value.html">CacheValue</a> &amp;<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">other</a>) <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a></td></tr>
<tr class="separator:ac75e4c70aef55fde8f257b843dd5f28f"><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:adf9f3fe86ca48d1d506b87cf4b3d5350" id="r_adf9f3fe86ca48d1d506b87cf4b3d5350"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpaimon_1_1_memory_segment.html">MemorySegment</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_cache_value.html#adf9f3fe86ca48d1d506b87cf4b3d5350">segment_</a></td></tr>
<tr class="separator:adf9f3fe86ca48d1d506b87cf4b3d5350"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13a8fbb7000759dd5e3d18fb8e35a62b" id="r_a13a8fbb7000759dd5e3d18fb8e35a62b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepaimon.html#a9964a294431d6d8c0d6ac26a7a8fc7df">CacheCallback</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_cache_value.html#a13a8fbb7000759dd5e3d18fb8e35a62b">callback_</a></td></tr>
<tr class="separator:a13a8fbb7000759dd5e3d18fb8e35a62b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a20590cf803d6bb4ed0ed707ec7382694" name="a20590cf803d6bb4ed0ed707ec7382694"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20590cf803d6bb4ed0ed707ec7382694">&#9670;&#160;</a></span>CacheValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">paimon::CacheValue::CacheValue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="classpaimon_1_1_memory_segment.html">MemorySegment</a> &amp;&#160;</td>
<td class="paramname"><em>segment</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacepaimon.html#a9964a294431d6d8c0d6ac26a7a8fc7df">CacheCallback</a>&#160;</td>
<td class="paramname"><em>callback</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af094fb7bbbc3d2a9fdea773febe3aace" name="af094fb7bbbc3d2a9fdea773febe3aace"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af094fb7bbbc3d2a9fdea773febe3aace">&#9670;&#160;</a></span>~CacheValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">paimon::CacheValue::~CacheValue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a07777a1933981e988d3eaae040725691" name="a07777a1933981e988d3eaae040725691"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07777a1933981e988d3eaae040725691">&#9670;&#160;</a></span>GetSegment()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="classpaimon_1_1_memory_segment.html">MemorySegment</a> &amp; paimon::CacheValue::GetSegment </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aa72715705a5cef8c7582ab2ae43d6fc3" name="aa72715705a5cef8c7582ab2ae43d6fc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa72715705a5cef8c7582ab2ae43d6fc3">&#9670;&#160;</a></span>OnEvict()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">void</a> paimon::CacheValue::OnEvict </td>
<td>(</td>
<td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> std::shared_ptr&lt; <a class="el" href="classpaimon_1_1_cache_key.html">CacheKey</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>key</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac75e4c70aef55fde8f257b843dd5f28f" name="ac75e4c70aef55fde8f257b843dd5f28f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac75e4c70aef55fde8f257b843dd5f28f">&#9670;&#160;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">bool</a> paimon::CacheValue::operator== </td>
<td>(</td>
<td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="classpaimon_1_1_cache_value.html">CacheValue</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="adf9f3fe86ca48d1d506b87cf4b3d5350" name="adf9f3fe86ca48d1d506b87cf4b3d5350"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf9f3fe86ca48d1d506b87cf4b3d5350">&#9670;&#160;</a></span>segment_</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="classpaimon_1_1_memory_segment.html">MemorySegment</a> paimon::CacheValue::segment_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a13a8fbb7000759dd5e3d18fb8e35a62b" name="a13a8fbb7000759dd5e3d18fb8e35a62b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13a8fbb7000759dd5e3d18fb8e35a62b">&#9670;&#160;</a></span>callback_</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="namespacepaimon.html#a9964a294431d6d8c0d6ac26a7a8fc7df">CacheCallback</a> paimon::CacheValue::callback_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/cache/<a class="el" href="cache_8h_source.html">cache.h</a></li>
</ul>
</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.8
</small></address>
</body>
</html>