blob: 66e5acff7df8de90cbdfb8c41f4f32fcfa2a6276 [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: /home/runner/work/paimon-cpp/paimon-cpp/include/paimon/memory/memory_pool.h File 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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d5ce83a91c1ada980bd794a9f3314520.html">paimon</a></li><li class="navelem"><a class="el" href="dir_e9e9def0e1178aa8ef569fa20d859019.html">memory</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">memory_pool.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;cassert&gt;</code><br />
<code>#include &lt;cstddef&gt;</code><br />
<code>#include &lt;cstdint&gt;</code><br />
<code>#include &lt;functional&gt;</code><br />
<code>#include &lt;memory&gt;</code><br />
<code>#include &lt;new&gt;</code><br />
<code>#include &lt;utility&gt;</code><br />
<code>#include &quot;paimon/macros.h&quot;</code><br />
<code>#include &quot;<a class="el" href="visibility_8h_source.html">paimon/visibility.h</a>&quot;</code><br />
</div>
<p><a href="memory__pool_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_memory_pool.html">paimon::MemoryPool</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abstract base class for memory pool implementations that provides controlled memory management. <a href="classpaimon_1_1_memory_pool.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_memory_pool_1_1_allocator_delete.html">paimon::MemoryPool::AllocatorDelete&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Custom deleter for use with std::unique_ptr that integrates with memory pools. <a href="classpaimon_1_1_memory_pool_1_1_allocator_delete.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacepaimon" id="r_namespacepaimon"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepaimon.html">paimon</a></td></tr>
<tr class="memdesc:namespacepaimon"><td class="mdescLeft">&#160;</td><td class="mdescRight">Top-level namespace for Paimon C++ API. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a147ba4ba34a215b3a4f3a95c1ee11704" id="r_a147ba4ba34a215b3a4f3a95c1ee11704"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">PAIMON_UNIQUE_PTR</a>&#160;&#160;&#160;pooled_unique_ptr</td></tr>
<tr class="separator:a147ba4ba34a215b3a4f3a95c1ee11704"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ad9357bd42a7936e920dfd1e9faf8da97" id="r_ad9357bd42a7936e920dfd1e9faf8da97"><td class="memTemplParams" colspan="2">template&lt;<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">class</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a> &gt; </td></tr>
<tr class="memitem:ad9357bd42a7936e920dfd1e9faf8da97"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">using</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacepaimon.html#ad9357bd42a7936e920dfd1e9faf8da97">paimon::pooled_unique_ptr</a> = std::unique_ptr&lt; <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a>, <a class="el" href="classpaimon_1_1_memory_pool_1_1_allocator_delete.html">MemoryPool::AllocatorDelete</a>&lt; <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a> &gt; &gt;</td></tr>
<tr class="separator:ad9357bd42a7936e920dfd1e9faf8da97"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae2688243d30a03f67aae1b058af30b56" id="r_ae2688243d30a03f67aae1b058af30b56"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classpaimon_1_1_memory_pool.html">MemoryPool</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepaimon.html#ae2688243d30a03f67aae1b058af30b56">paimon::GetMemoryPool</a> ()</td></tr>
<tr class="memdesc:ae2688243d30a03f67aae1b058af30b56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a default implementation of memory pool. <br /></td></tr>
<tr class="separator:ae2688243d30a03f67aae1b058af30b56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2363ca49fc078c7f28ce9e712000776" id="r_af2363ca49fc078c7f28ce9e712000776"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classpaimon_1_1_memory_pool.html">MemoryPool</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepaimon.html#af2363ca49fc078c7f28ce9e712000776">paimon::GetDefaultPool</a> ()</td></tr>
<tr class="memdesc:af2363ca49fc078c7f28ce9e712000776"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a system-wide singleton memory pool. <br /></td></tr>
<tr class="separator:af2363ca49fc078c7f28ce9e712000776"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a147ba4ba34a215b3a4f3a95c1ee11704" name="a147ba4ba34a215b3a4f3a95c1ee11704"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a147ba4ba34a215b3a4f3a95c1ee11704">&#9670;&#160;</a></span>PAIMON_UNIQUE_PTR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PAIMON_UNIQUE_PTR&#160;&#160;&#160;pooled_unique_ptr</td>
</tr>
</table>
</div><div class="memdoc">
</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.8
</small></address>
</body>
</html>