Google Git
Sign in
apache/paimon-cpp/refs/heads/gh-pages/./apidoc/html/classpaimon_1_1_singleton.html
blob: 797772b54d495cccd71f063777c647035444d71f [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::Singleton&lt; T, InstPolicy &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 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_singleton.html">Singleton</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classpaimon_1_1_singleton-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">paimon::Singleton&lt; T, InstPolicy &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A singleton implementation with customizable instantiation policy.
<a href="classpaimon_1_1_singleton.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="singleton_8h_source.html">/home/runner/work/paimon-cpp/paimon-cpp/include/paimon/factories/singleton.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for paimon::Singleton&lt; T, InstPolicy &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classpaimon_1_1_singleton.png" usemap="#paimon::Singleton_3C_20T_2C_20InstPolicy_20_3E_map" alt=""/>
<map id="paimon::Singleton_3C_20T_2C_20InstPolicy_20_3E_map" name="paimon::Singleton_3C_20T_2C_20InstPolicy_20_3E_map">
<area href="classpaimon_1_1_lazy_instantiation.html" alt="paimon::LazyInstantiation" shape="rect" coords="0,0,204,24"/>
</map>
</div></div>
<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:a37b34e5de25240c0290da878f713a344" id="r_a37b34e5de25240c0290da878f713a344"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_singleton.html#a37b34e5de25240c0290da878f713a344">~Singleton</a> ()=<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">default</a></td></tr>
<tr class="separator:a37b34e5de25240c0290da878f713a344"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a4fad71c69624a114e6797f65f74f32e4" id="r_a4fad71c69624a114e6797f65f74f32e4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_singleton.html#a4fad71c69624a114e6797f65f74f32e4">GetInstance</a> ()</td></tr>
<tr class="memdesc:a4fad71c69624a114e6797f65f74f32e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provide access to the single instance through double-checked locking. <br /></td></tr>
<tr class="separator:a4fad71c69624a114e6797f65f74f32e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ad82366e89efd3c290420b897572e8717" id="r_ad82366e89efd3c290420b897572e8717"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_singleton.html#ad82366e89efd3c290420b897572e8717">Singleton</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="classpaimon_1_1_singleton.html">Singleton</a> &amp;)</td></tr>
<tr class="separator:ad82366e89efd3c290420b897572e8717"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7ad28036c78d314386151fbdc3bdf39" id="r_aa7ad28036c78d314386151fbdc3bdf39"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_singleton.html#aa7ad28036c78d314386151fbdc3bdf39">Singleton</a> ()=<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">default</a></td></tr>
<tr class="separator:aa7ad28036c78d314386151fbdc3bdf39"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classpaimon_1_1_lazy_instantiation"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classpaimon_1_1_lazy_instantiation')"><img src="closed.png" alt="-"/>&#160;Static Private Member Functions inherited from <a class="el" href="classpaimon_1_1_lazy_instantiation.html">paimon::LazyInstantiation</a></td></tr>
<tr class="memitem:ab054c02c6c9c1914a276688943c7cb7e inherit pub_static_methods_classpaimon_1_1_lazy_instantiation" id="r_ab054c02c6c9c1914a276688943c7cb7e"><td class="memTemplParams" colspan="2">template&lt;<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">typename</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a> &gt; </td></tr>
<tr class="memitem:ab054c02c6c9c1914a276688943c7cb7e inherit pub_static_methods_classpaimon_1_1_lazy_instantiation"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">void</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_lazy_instantiation.html#ab054c02c6c9c1914a276688943c7cb7e">Create</a> (<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a> *&amp;<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">ptr</a>)</td></tr>
<tr class="separator:ab054c02c6c9c1914a276688943c7cb7e inherit pub_static_methods_classpaimon_1_1_lazy_instantiation"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">typename</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">typename</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">InstPolicy</a> = LazyInstantiation&gt;<br />
class paimon::Singleton&lt; T, InstPolicy &gt;</div><p>A singleton implementation with customizable instantiation policy. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad82366e89efd3c290420b897572e8717" name="ad82366e89efd3c290420b897572e8717"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad82366e89efd3c290420b897572e8717">&#9670;&#160;</a></span>Singleton() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">typename</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a> , <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">typename</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">InstPolicy</a> = LazyInstantiation&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpaimon_1_1_singleton.html">paimon::Singleton</a>&lt; <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">InstPolicy</a> &gt;::Singleton </td>
<td>(</td>
<td class="paramtype"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">const</a> <a class="el" href="classpaimon_1_1_singleton.html">Singleton</a>&lt; <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">InstPolicy</a> &gt; &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aa7ad28036c78d314386151fbdc3bdf39" name="aa7ad28036c78d314386151fbdc3bdf39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7ad28036c78d314386151fbdc3bdf39">&#9670;&#160;</a></span>Singleton() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">typename</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a> , <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">typename</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">InstPolicy</a> = LazyInstantiation&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpaimon_1_1_singleton.html">paimon::Singleton</a>&lt; <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">InstPolicy</a> &gt;::Singleton </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a37b34e5de25240c0290da878f713a344" name="a37b34e5de25240c0290da878f713a344"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37b34e5de25240c0290da878f713a344">&#9670;&#160;</a></span>~Singleton()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">typename</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a> , <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">typename</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">InstPolicy</a> = LazyInstantiation&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpaimon_1_1_singleton.html">paimon::Singleton</a>&lt; <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">InstPolicy</a> &gt;::~<a class="el" href="classpaimon_1_1_singleton.html">Singleton</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a4fad71c69624a114e6797f65f74f32e4" name="a4fad71c69624a114e6797f65f74f32e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fad71c69624a114e6797f65f74f32e4">&#9670;&#160;</a></span>GetInstance()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">typename</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a> , <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">typename</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">InstPolicy</a> = LazyInstantiation&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">static</a> <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a> * <a class="el" href="classpaimon_1_1_singleton.html">paimon::Singleton</a>&lt; <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a>, <a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">InstPolicy</a> &gt;::GetInstance </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provide access to the single instance through double-checked locking. </p>
<p>Lazy create a singleton instance when <code><a class="el" href="classpaimon_1_1_singleton.html#a4fad71c69624a114e6797f65f74f32e4" title="Provide access to the single instance through double-checked locking.">GetInstance()</a></code> is called.</p>
<dl class="section return"><dt>Returns</dt><dd>The single instance of object. </dd></dl>
</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/factories/<a class="el" href="singleton_8h_source.html">singleton.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>