| <!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/factories/singleton.h Source File</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&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&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function() { init_codefold(0); }); |
| /* @license-end */ |
| </script> |
| <!-- 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_60649a063c079650afe6e44ab3cf8648.html">factories</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">singleton.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="singleton_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Copyright 2014-present Alibaba Inc.</span></div> |
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span></div> |
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * you may not use this file except in compliance with the License.</span></div> |
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * You may obtain a copy of the License at</span></div> |
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div> |
| <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div> |
| <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * See the License for the specific language governing permissions and</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * limitations under the License.</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">// Adapted from Alibaba Havenask</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">// https://github.com/alibaba/havenask/blob/main/aios/storage/indexlib/util/Singleton.h</span></div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include "paimon/macros.h"</span></div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include "<a class="code" href="visibility_8h.html">paimon/visibility.h</a>"</span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacepaimon.html">paimon</a> {</div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div> |
| <div class="foldopen" id="foldopen00029" data-start="{" data-end="};"> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="classpaimon_1_1_lazy_instantiation.html"> 29</a></span><span class="keyword">class </span><a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">PAIMON_EXPORT</a> <a class="code hl_class" href="classpaimon_1_1_lazy_instantiation.html">LazyInstantiation</a> {</div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">protected</span>:</div> |
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div> |
| <div class="foldopen" id="foldopen00032" data-start="{" data-end="}"> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="classpaimon_1_1_lazy_instantiation.html#ab054c02c6c9c1914a276688943c7cb7e"> 32</a></span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classpaimon_1_1_lazy_instantiation.html#ab054c02c6c9c1914a276688943c7cb7e">Create</a>(<a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a>*& <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">ptr</a>) {</div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a>* <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">tmp</a> = <span class="keyword">new</span> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a>;</div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">MEMORY_BARRIER</a>();</div> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">ptr</a> = <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">tmp</a>;</div> |
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">static</span> std::shared_ptr<T> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">destroyer</a>(<a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">ptr</a>);</div> |
| <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> }</div> |
| </div> |
| <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span>};</div> |
| </div> |
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="keyword">template</span> <<span class="keyword">typename</span> T, <span class="keyword">typename</span> InstPolicy = LazyInstantiation></div> |
| <div class="foldopen" id="foldopen00042" data-start="{" data-end="};"> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="classpaimon_1_1_singleton.html"> 42</a></span><span class="keyword">class </span><a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">PAIMON_EXPORT</a> <a class="code hl_class" href="classpaimon_1_1_singleton.html">Singleton</a> : <span class="keyword">private</span> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">InstPolicy</a> {</div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">protected</span>:</div> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classpaimon_1_1_singleton.html#ad82366e89efd3c290420b897572e8717"> 44</a></span> <a class="code hl_function" href="classpaimon_1_1_singleton.html#ad82366e89efd3c290420b897572e8717">Singleton</a>(<span class="keyword">const</span> <a class="code hl_class" href="classpaimon_1_1_singleton.html">Singleton</a>&) {}</div> |
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="classpaimon_1_1_singleton.html#aa7ad28036c78d314386151fbdc3bdf39"> 45</a></span> <a class="code hl_function" href="classpaimon_1_1_singleton.html#aa7ad28036c78d314386151fbdc3bdf39">Singleton</a>() = <span class="keywordflow">default</span>;</div> |
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div> |
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classpaimon_1_1_singleton.html#a37b34e5de25240c0290da878f713a344"> 48</a></span> <a class="code hl_function" href="classpaimon_1_1_singleton.html#a37b34e5de25240c0290da878f713a344">~Singleton</a>() = <span class="keywordflow">default</span>;</div> |
| <div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="classpaimon_1_1_singleton.html#a4fad71c69624a114e6797f65f74f32e4"> 56</a></span> <span class="keyword">static</span> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">T</a>* <a class="code hl_function" href="classpaimon_1_1_singleton.html#a4fad71c69624a114e6797f65f74f32e4">GetInstance</a>();</div> |
| <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>};</div> |
| </div> |
| <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div> |
| <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span>} <span class="comment">// namespace paimon</span></div> |
| <div class="ttc" id="aclasspaimon_1_1_lazy_instantiation_html"><div class="ttname"><a href="classpaimon_1_1_lazy_instantiation.html">paimon::LazyInstantiation</a></div><div class="ttdef"><b>Definition</b> singleton.h:29</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_lazy_instantiation_html_ab054c02c6c9c1914a276688943c7cb7e"><div class="ttname"><a href="classpaimon_1_1_lazy_instantiation.html#ab054c02c6c9c1914a276688943c7cb7e">paimon::LazyInstantiation::Create</a></div><div class="ttdeci">static void Create(T *&ptr)</div><div class="ttdef"><b>Definition</b> singleton.h:32</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_singleton_html"><div class="ttname"><a href="classpaimon_1_1_singleton.html">paimon::Singleton</a></div><div class="ttdoc">A singleton implementation with customizable instantiation policy.</div><div class="ttdef"><b>Definition</b> singleton.h:42</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_singleton_html_a37b34e5de25240c0290da878f713a344"><div class="ttname"><a href="classpaimon_1_1_singleton.html#a37b34e5de25240c0290da878f713a344">paimon::Singleton::~Singleton</a></div><div class="ttdeci">~Singleton()=default</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_singleton_html_a4fad71c69624a114e6797f65f74f32e4"><div class="ttname"><a href="classpaimon_1_1_singleton.html#a4fad71c69624a114e6797f65f74f32e4">paimon::Singleton::GetInstance</a></div><div class="ttdeci">static T * GetInstance()</div><div class="ttdoc">Provide access to the single instance through double-checked locking.</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_singleton_html_aa7ad28036c78d314386151fbdc3bdf39"><div class="ttname"><a href="classpaimon_1_1_singleton.html#aa7ad28036c78d314386151fbdc3bdf39">paimon::Singleton::Singleton</a></div><div class="ttdeci">Singleton()=default</div></div> |
| <div class="ttc" id="aclasspaimon_1_1_singleton_html_ad82366e89efd3c290420b897572e8717"><div class="ttname"><a href="classpaimon_1_1_singleton.html#ad82366e89efd3c290420b897572e8717">paimon::Singleton::Singleton</a></div><div class="ttdeci">Singleton(const Singleton &)</div><div class="ttdef"><b>Definition</b> singleton.h:44</div></div> |
| <div class="ttc" id="amemory__pool_8h_html_a147ba4ba34a215b3a4f3a95c1ee11704"><div class="ttname"><a href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">PAIMON_UNIQUE_PTR</a></div><div class="ttdeci">#define PAIMON_UNIQUE_PTR</div><div class="ttdef"><b>Definition</b> memory_pool.h:219</div></div> |
| <div class="ttc" id="anamespacepaimon_html"><div class="ttname"><a href="namespacepaimon.html">paimon</a></div><div class="ttdoc">Top-level namespace for Paimon C++ API.</div><div class="ttdef"><b>Definition</b> api.h:42</div></div> |
| <div class="ttc" id="avisibility_8h_html"><div class="ttname"><a href="visibility_8h.html">visibility.h</a></div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <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> |
