blob: 50a4170c2bef79ef9fa09e0a9cfed4d5f502a2da [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<link rel="canonical" href="https://ignite.apache.org/releases/2.5.0/cppdoc/reference_8h.html" />
<META NAME="ROBOTS" CONTENT="NOINDEX">
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>&nbsp; Apache Ignite C++: reference.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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61232409-1', 'auto');
ga('send', 'pageview');
</script></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 style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="ignite_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">&nbsp; Apache Ignite C++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_bdd9a5d540de89e9fe90efdfc6973a4f.html">common</a></li><li class="navelem"><a class="el" href="dir_11fbc4217d50ab21044e5ad6614aede5.html">include</a></li><li class="navelem"><a class="el" href="dir_2dedece15635f75054d44afc50ccfbaf.html">ignite</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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">reference.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Declares <a class="el" href="classignite_1_1Reference.html" title="Reference class. ">ignite::Reference</a> class.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;cstddef&gt;</code><br />
<code>#include &lt;ignite/common/common.h&gt;</code><br />
<code>#include &lt;ignite/common/concurrent.h&gt;</code><br />
<code>#include &lt;ignite/common/reference_impl.h&gt;</code><br />
</div>
<p><a href="reference_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 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="classignite_1_1Reference.html">ignite::Reference&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classignite_1_1Reference.html" title="Reference class. ">Reference</a> class. <a href="classignite_1_1Reference.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="classignite_1_1ConstReference.html">ignite::ConstReference&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constant <a class="el" href="classignite_1_1Reference.html" title="Reference class. ">Reference</a> class. <a href="classignite_1_1ConstReference.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="classignite_1_1Reference.html">ignite::Reference&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classignite_1_1Reference.html" title="Reference class. ">Reference</a> class. <a href="classignite_1_1Reference.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 name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceignite"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceignite.html">ignite</a></td></tr>
<tr class="memdesc:namespaceignite"><td class="mdescLeft">&#160;</td><td class="mdescRight">Apache Ignite 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 name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a01845a228a65220aed4fa281e408c610"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a01845a228a65220aed4fa281e408c610"><td class="memTemplItemLeft" align="right" valign="top">Reference&lt; typename T::element_type &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceignite.html#a01845a228a65220aed4fa281e408c610">ignite::MakeReferenceFromSmartPointer</a> (T ptr)</td></tr>
<tr class="memdesc:a01845a228a65220aed4fa281e408c610"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make <a class="el" href="classignite_1_1Reference.html" title="Reference class. ">ignite::Reference</a> instance out of smart pointer. <a href="namespaceignite.html#a01845a228a65220aed4fa281e408c610">More...</a><br /></td></tr>
<tr class="separator:a01845a228a65220aed4fa281e408c610"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d056cf27c881af6b06bda130d0f64ed"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a4d056cf27c881af6b06bda130d0f64ed"><td class="memTemplItemLeft" align="right" valign="top">ConstReference&lt; typename T::element_type &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceignite.html#a4d056cf27c881af6b06bda130d0f64ed">ignite::MakeConstReferenceFromSmartPointer</a> (T ptr)</td></tr>
<tr class="memdesc:a4d056cf27c881af6b06bda130d0f64ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make <a class="el" href="classignite_1_1ConstReference.html" title="Constant Reference class. ">ignite::ConstReference</a> instance out of smart pointer. <a href="namespaceignite.html#a4d056cf27c881af6b06bda130d0f64ed">More...</a><br /></td></tr>
<tr class="separator:a4d056cf27c881af6b06bda130d0f64ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1876725dc2d3119c5a0b15cf417aa1d0"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a1876725dc2d3119c5a0b15cf417aa1d0"><td class="memTemplItemLeft" align="right" valign="top">Reference&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceignite.html#a1876725dc2d3119c5a0b15cf417aa1d0">ignite::MakeReferenceFromCopy</a> (const T &amp;val)</td></tr>
<tr class="memdesc:a1876725dc2d3119c5a0b15cf417aa1d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy object and wrap it to make <a class="el" href="classignite_1_1Reference.html" title="Reference class. ">ignite::Reference</a> instance. <a href="namespaceignite.html#a1876725dc2d3119c5a0b15cf417aa1d0">More...</a><br /></td></tr>
<tr class="separator:a1876725dc2d3119c5a0b15cf417aa1d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a713b8934e0021d44b99f15acae86efe2"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a713b8934e0021d44b99f15acae86efe2"><td class="memTemplItemLeft" align="right" valign="top">ConstReference&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceignite.html#a713b8934e0021d44b99f15acae86efe2">ignite::MakeConstReferenceFromCopy</a> (const T &amp;val)</td></tr>
<tr class="memdesc:a713b8934e0021d44b99f15acae86efe2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy object and wrap it to make <a class="el" href="classignite_1_1ConstReference.html" title="Constant Reference class. ">ignite::ConstReference</a> instance. <a href="namespaceignite.html#a713b8934e0021d44b99f15acae86efe2">More...</a><br /></td></tr>
<tr class="separator:a713b8934e0021d44b99f15acae86efe2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a700a57aef7b1a3ebd13feed33dcf4170"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a700a57aef7b1a3ebd13feed33dcf4170"><td class="memTemplItemLeft" align="right" valign="top">Reference&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceignite.html#a700a57aef7b1a3ebd13feed33dcf4170">ignite::MakeReferenceFromOwningPointer</a> (T *val)</td></tr>
<tr class="memdesc:a700a57aef7b1a3ebd13feed33dcf4170"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make <a class="el" href="classignite_1_1Reference.html" title="Reference class. ">ignite::Reference</a> instance out of pointer and pass its ownership. <a href="namespaceignite.html#a700a57aef7b1a3ebd13feed33dcf4170">More...</a><br /></td></tr>
<tr class="separator:a700a57aef7b1a3ebd13feed33dcf4170"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b46914ac275250143be90e5bc2411e2"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a6b46914ac275250143be90e5bc2411e2"><td class="memTemplItemLeft" align="right" valign="top">ConstReference&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceignite.html#a6b46914ac275250143be90e5bc2411e2">ignite::MakeConstReferenceFromOwningPointer</a> (T *val)</td></tr>
<tr class="memdesc:a6b46914ac275250143be90e5bc2411e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make <a class="el" href="classignite_1_1ConstReference.html" title="Constant Reference class. ">ignite::ConstReference</a> instance out of pointer and pass its ownership. <a href="namespaceignite.html#a6b46914ac275250143be90e5bc2411e2">More...</a><br /></td></tr>
<tr class="separator:a6b46914ac275250143be90e5bc2411e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55790b7e48e45cd757e7d34aacc4357a"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a55790b7e48e45cd757e7d34aacc4357a"><td class="memTemplItemLeft" align="right" valign="top">Reference&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceignite.html#a55790b7e48e45cd757e7d34aacc4357a">ignite::MakeReference</a> (T &amp;val)</td></tr>
<tr class="memdesc:a55790b7e48e45cd757e7d34aacc4357a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make <a class="el" href="classignite_1_1Reference.html" title="Reference class. ">ignite::Reference</a> instance out of reference. <a href="namespaceignite.html#a55790b7e48e45cd757e7d34aacc4357a">More...</a><br /></td></tr>
<tr class="separator:a55790b7e48e45cd757e7d34aacc4357a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1523106a14156cf653b3366d92562cd"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ac1523106a14156cf653b3366d92562cd"><td class="memTemplItemLeft" align="right" valign="top">Reference&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceignite.html#ac1523106a14156cf653b3366d92562cd">ignite::MakeReference</a> (T *val)</td></tr>
<tr class="memdesc:ac1523106a14156cf653b3366d92562cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make <a class="el" href="classignite_1_1Reference.html" title="Reference class. ">ignite::Reference</a> instance out of pointer. <a href="namespaceignite.html#ac1523106a14156cf653b3366d92562cd">More...</a><br /></td></tr>
<tr class="separator:ac1523106a14156cf653b3366d92562cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae78424fdffadc92e84b815d5df9c6fee"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ae78424fdffadc92e84b815d5df9c6fee"><td class="memTemplItemLeft" align="right" valign="top">ConstReference&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceignite.html#ae78424fdffadc92e84b815d5df9c6fee">ignite::MakeConstReference</a> (const T &amp;val)</td></tr>
<tr class="memdesc:ae78424fdffadc92e84b815d5df9c6fee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make <a class="el" href="classignite_1_1ConstReference.html" title="Constant Reference class. ">ignite::ConstReference</a> instance out of constant reference. <a href="namespaceignite.html#ae78424fdffadc92e84b815d5df9c6fee">More...</a><br /></td></tr>
<tr class="separator:ae78424fdffadc92e84b815d5df9c6fee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae937deaf9a618b1441ad3e49c76f4b8d"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ae937deaf9a618b1441ad3e49c76f4b8d"><td class="memTemplItemLeft" align="right" valign="top">ConstReference&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceignite.html#ae937deaf9a618b1441ad3e49c76f4b8d">ignite::MakeConstReference</a> (const T *val)</td></tr>
<tr class="memdesc:ae937deaf9a618b1441ad3e49c76f4b8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make <a class="el" href="classignite_1_1ConstReference.html" title="Constant Reference class. ">ignite::ConstReference</a> instance out of constant pointer. <a href="namespaceignite.html#ae937deaf9a618b1441ad3e49c76f4b8d">More...</a><br /></td></tr>
<tr class="separator:ae937deaf9a618b1441ad3e49c76f4b8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Declares <a class="el" href="classignite_1_1Reference.html" title="Reference class. ">ignite::Reference</a> class. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed May 23 2018 17:47:00 for &nbsp; Apache Ignite C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>