apidoc/html/factory_8h.html - paimon-cpp - Git at Google

 <!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/factory.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_60649a063c079650afe6e44ab3cf8648.html">factories</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>  </div>
   <div class="headertitle"><div class="title">factory.h File Reference</div></div>
 </div><!--header-->
 <div class="contents">
 <div class="textblock"><code>#include &quot;<a class="el" href="factory__creator_8h_source.html">paimon/factories/factory_creator.h</a>&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="factory_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_factory.html">paimon::Factory</a></td></tr>
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classpaimon_1_1_factory.html" title="Factory used to register, e.g., FileFormatFactory, FileSystemFactory.">Factory</a> used to register, e.g., <code><a class="el" href="classpaimon_1_1_file_format_factory.html" title="A factory for creating FileFormat instances.">FileFormatFactory</a></code>, <code><a class="el" href="classpaimon_1_1_file_system_factory.html" title="A factory for creating FileSystem instances.">FileSystemFactory</a></code>.  <a href="classpaimon_1_1_factory.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:a08d014c2b81c78ca58bb76eae0a1f6db" id="r_a08d014c2b81c78ca58bb76eae0a1f6db"><td class="memItemLeft" align="right" valign="top">#<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">define</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="factory_8h.html#a08d014c2b81c78ca58bb76eae0a1f6db">REGISTER_PAIMON_FACTORY</a>(<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">PAIMON_FACTORY</a>)</td></tr>
 <tr class="separator:a08d014c2b81c78ca58bb76eae0a1f6db"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <h2 class="groupheader">Macro Definition Documentation</h2>
 <a id="a08d014c2b81c78ca58bb76eae0a1f6db" name="a08d014c2b81c78ca58bb76eae0a1f6db"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a08d014c2b81c78ca58bb76eae0a1f6db">&#9670;&#160;</a></span>REGISTER_PAIMON_FACTORY</h2>

 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">#<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">define</a> REGISTER_PAIMON_FACTORY</td>
           <td>(</td>
           <td class="paramtype">&#160;</td>
           <td class="paramname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">PAIMON_FACTORY</a></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">
 <b>Value:</b><div class="fragment"><div class="line">    <span class="keyword">static</span> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">__attribute__</a>((<a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">constructor</a>)) <span class="keywordtype">void</span> Register##<a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">PAIMON_FACTORY</a>##Factory() { \</div>
 <div class="line">        <span class="keyword">auto</span> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">factory_creator</a> = <a class="code hl_function" href="classpaimon_1_1_singleton.html#a7b1a4fbab64fbc2fef4e019ed5c00690">paimon::FactoryCreator::GetInstance</a>();              \</div>
 <div class="line">        <span class="keyword">auto</span>* <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">factory</a> = <span class="keyword">new</span> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">PAIMON_FACTORY</a>;                                        \</div>
 <div class="line">        <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">factory_creator</a>-&gt;Register(<a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">factory</a>-&gt;Identifier(), <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">factory</a>);                 \</div>
 <div class="line">    }</div>
 <div class="ttc" id="aclasspaimon_1_1_singleton_html_a7b1a4fbab64fbc2fef4e019ed5c00690"><div class="ttname"><a href="classpaimon_1_1_singleton.html#a7b1a4fbab64fbc2fef4e019ed5c00690">paimon::Singleton&lt; FactoryCreator &gt;::GetInstance</a></div><div class="ttdeci">static FactoryCreator * GetInstance()</div><div class="ttdoc">Provide access to the single instance through double-checked locking.</div><div class="ttdef"><b>Definition</b> singleton.h:62</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:220</div></div>
 </div><!-- fragment -->
 </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>
	<!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/factory.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&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>
	<!-- 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="summary">
	<a href="#nested-classes">Classes</a> \|
	<a href="#namespaces">Namespaces</a> \|
	<a href="#define-members">Macros</a> </div>
	<div class="headertitle"><div class="title">factory.h File Reference</div></div>
	</div><!--header-->
	<div class="contents">
	<div class="textblock"><code>#include "<a class="el" href="factory__creator_8h_source.html">paimon/factories/factory_creator.h</a>"</code><br />
	<code>#include "<a class="el" href="visibility_8h_source.html">paimon/visibility.h</a>"</code><br />
	</div>
	<p><a href="factory_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  </td><td class="memItemRight" valign="bottom"><a class="el" href="classpaimon_1_1_factory.html">paimon::Factory</a></td></tr>
	<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classpaimon_1_1_factory.html" title="Factory used to register, e.g., FileFormatFactory, FileSystemFactory.">Factory</a> used to register, e.g., <code><a class="el" href="classpaimon_1_1_file_format_factory.html" title="A factory for creating FileFormat instances.">FileFormatFactory</a></code>, <code><a class="el" href="classpaimon_1_1_file_system_factory.html" title="A factory for creating FileSystem instances.">FileSystemFactory</a></code>. <a href="classpaimon_1_1_factory.html#details">More...</a><br /></td></tr>
	<tr class="separator:"><td class="memSeparator" colspan="2"> </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  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepaimon.html">paimon</a></td></tr>
	<tr class="memdesc:namespacepaimon"><td class="mdescLeft"> </td><td class="mdescRight">Top-level namespace for Paimon C++ API. <br /></td></tr>
	<tr class="separator:"><td class="memSeparator" colspan="2"> </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:a08d014c2b81c78ca58bb76eae0a1f6db" id="r_a08d014c2b81c78ca58bb76eae0a1f6db"><td class="memItemLeft" align="right" valign="top">#<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">define</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="factory_8h.html#a08d014c2b81c78ca58bb76eae0a1f6db">REGISTER_PAIMON_FACTORY</a>(<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">PAIMON_FACTORY</a>)</td></tr>
	<tr class="separator:a08d014c2b81c78ca58bb76eae0a1f6db"><td class="memSeparator" colspan="2"> </td></tr>
	</table>
	<h2 class="groupheader">Macro Definition Documentation</h2>
	<a id="a08d014c2b81c78ca58bb76eae0a1f6db" name="a08d014c2b81c78ca58bb76eae0a1f6db"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#a08d014c2b81c78ca58bb76eae0a1f6db">◆ </a></span>REGISTER_PAIMON_FACTORY</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">#<a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">define</a> REGISTER_PAIMON_FACTORY</td>
	<td>(</td>
	<td class="paramtype"> </td>
	<td class="paramname"><a class="el" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">PAIMON_FACTORY</a></td><td>)</td>
	<td></td>
	</tr>
	</table>
	</div><div class="memdoc">
	<b>Value:</b><div class="fragment"><div class="line"> <span class="keyword">static</span> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">__attribute__</a>((<a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">constructor</a>)) <span class="keywordtype">void</span> Register##<a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">PAIMON_FACTORY</a>##Factory() { \</div>
	<div class="line"> <span class="keyword">auto</span> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">factory_creator</a> = <a class="code hl_function" href="classpaimon_1_1_singleton.html#a7b1a4fbab64fbc2fef4e019ed5c00690">paimon::FactoryCreator::GetInstance</a>(); \</div>
	<div class="line"> <span class="keyword">auto</span>* <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">factory</a> = <span class="keyword">new</span> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">PAIMON_FACTORY</a>; \</div>
	<div class="line"> <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">factory_creator</a>->Register(<a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">factory</a>->Identifier(), <a class="code hl_define" href="memory__pool_8h.html#a147ba4ba34a215b3a4f3a95c1ee11704">factory</a>); \</div>
	<div class="line"> }</div>
	<div class="ttc" id="aclasspaimon_1_1_singleton_html_a7b1a4fbab64fbc2fef4e019ed5c00690"><div class="ttname"><a href="classpaimon_1_1_singleton.html#a7b1a4fbab64fbc2fef4e019ed5c00690">paimon::Singleton< FactoryCreator >::GetInstance</a></div><div class="ttdeci">static FactoryCreator * GetInstance()</div><div class="ttdoc">Provide access to the single instance through double-checked locking.</div><div class="ttdef"><b>Definition</b> singleton.h:62</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:220</div></div>
	</div><!-- fragment -->
	</div>
	</div>
	</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>