blob: 1a342857660c81aa040442fa961152bf3c3e24ba [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/1.8.0/cppdoc/namespaceignite_1_1cache.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.9.1"/>
<title>&nbsp; Apache Ignite C++: ignite::cache Namespace 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 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.9.1 -->
<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 class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><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="namespaces.html"><span>Namespace&#160;List</span></a></li>
<li><a href="namespacemembers.html"><span>Namespace&#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="namespaceignite.html">ignite</a></li><li class="navelem"><a class="el" href="namespaceignite_1_1cache.html">cache</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#nested-classes">Classes</a> &#124;
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">ignite::cache Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Ignite Cache API.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceignite_1_1cache_1_1query"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceignite_1_1cache_1_1query.html">query</a></td></tr>
<tr class="memdesc:namespaceignite_1_1cache_1_1query"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains APIs for creating and executing cache queries. <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="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_1cache_1_1Cache.html">Cache</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main entry point for all Data Grid APIs. <a href="classignite_1_1cache_1_1Cache.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_1cache_1_1CacheEntry.html">CacheEntry</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cache entry class template. <a href="classignite_1_1cache_1_1CacheEntry.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="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a6def68803623999e3bc2a01a1451d63f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceignite_1_1cache.html#a6def68803623999e3bc2a01a1451d63f">CachePeekMode</a> { <br />
&#160;&#160;<a class="el" href="namespaceignite_1_1cache.html#a6def68803623999e3bc2a01a1451d63fa50e9c13c98d4a459a9528eea34be29c3">IGNITE_PEEK_MODE_ALL</a> = 0x01,
<a class="el" href="namespaceignite_1_1cache.html#a6def68803623999e3bc2a01a1451d63faccf69fd4fd31ae8e11a0a79a765c6c24">IGNITE_PEEK_MODE_NEAR</a> = 0x02,
<a class="el" href="namespaceignite_1_1cache.html#a6def68803623999e3bc2a01a1451d63fa32110c71f1e2792191489566f7cc40d0">IGNITE_PEEK_MODE_PRIMARY</a> = 0x04,
<a class="el" href="namespaceignite_1_1cache.html#a6def68803623999e3bc2a01a1451d63fa1564e46edb367d9ae924ab690b88de41">IGNITE_PEEK_MODE_BACKUP</a> = 0x08,
<br />
&#160;&#160;<a class="el" href="namespaceignite_1_1cache.html#a6def68803623999e3bc2a01a1451d63fab810d513afd515b2a529358107c91db6">IGNITE_PEEK_MODE_ONHEAP</a> = 0x10,
<a class="el" href="namespaceignite_1_1cache.html#a6def68803623999e3bc2a01a1451d63fa896a64a8ce67cc8e0ab8d316f555dc16">IGNITE_PEEK_MODE_OFFHEAP</a> = 0x20,
<a class="el" href="namespaceignite_1_1cache.html#a6def68803623999e3bc2a01a1451d63fad28bebf4953731d66a8a0fe259c31060">IGNITE_PEEK_MODE_SWAP</a> = 0x40
<br />
}</td></tr>
<tr class="memdesc:a6def68803623999e3bc2a01a1451d63f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumeration of all supported cache peek modes. <a href="namespaceignite_1_1cache.html#a6def68803623999e3bc2a01a1451d63f">More...</a><br /></td></tr>
<tr class="separator:a6def68803623999e3bc2a01a1451d63f"><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>Ignite Cache API. </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="a6def68803623999e3bc2a01a1451d63f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespaceignite_1_1cache.html#a6def68803623999e3bc2a01a1451d63f">ignite::cache::CachePeekMode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enumeration of all supported cache peek modes. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a6def68803623999e3bc2a01a1451d63fa50e9c13c98d4a459a9528eea34be29c3"></a>IGNITE_PEEK_MODE_ALL&#160;</td><td class="fielddoc">
<p>Peeks into all available cache storages. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a6def68803623999e3bc2a01a1451d63faccf69fd4fd31ae8e11a0a79a765c6c24"></a>IGNITE_PEEK_MODE_NEAR&#160;</td><td class="fielddoc">
<p>Peek into near cache only (don't peek into partitioned cache). </p>
<p>In case of LOCAL cache, behaves as IGNITE_PEEK_MODE_ALL mode. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a6def68803623999e3bc2a01a1451d63fa32110c71f1e2792191489566f7cc40d0"></a>IGNITE_PEEK_MODE_PRIMARY&#160;</td><td class="fielddoc">
<p>Peek value from primary copy of partitioned cache only (skip near cache). </p>
<p>In case of LOCAL cache, behaves as IGNITE_PEEK_MODE_ALL mode. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a6def68803623999e3bc2a01a1451d63fa1564e46edb367d9ae924ab690b88de41"></a>IGNITE_PEEK_MODE_BACKUP&#160;</td><td class="fielddoc">
<p>Peek value from backup copies of partitioned cache only (skip near cache). </p>
<p>In case of LOCAL cache, behaves as IGNITE_PEEK_MODE_ALL mode. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a6def68803623999e3bc2a01a1451d63fab810d513afd515b2a529358107c91db6"></a>IGNITE_PEEK_MODE_ONHEAP&#160;</td><td class="fielddoc">
<p>Peeks value from the on-heap storage only. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a6def68803623999e3bc2a01a1451d63fa896a64a8ce67cc8e0ab8d316f555dc16"></a>IGNITE_PEEK_MODE_OFFHEAP&#160;</td><td class="fielddoc">
<p>Peeks value from the off-heap storage only, without loading off-heap value into cache. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="a6def68803623999e3bc2a01a1451d63fad28bebf4953731d66a8a0fe259c31060"></a>IGNITE_PEEK_MODE_SWAP&#160;</td><td class="fielddoc">
<p>Peeks value from the swap storage only, without loading swapped value into cache. </p>
</td></tr>
</table>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Dec 5 2016 14:37:41 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.9.1
</small></address>
</body>
</html>