blob: ca2aa544b7afad468ead4ad94071a11de7479589 [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.8.0/cppdoc/structignite_1_1cache_1_1CachePeekMode.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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>&nbsp; Apache Ignite C++: ignite::cache::CachePeekMode Struct 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" />
<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.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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">
<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><li class="navelem"><a class="el" href="structignite_1_1cache_1_1CachePeekMode.html">CachePeekMode</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="structignite_1_1cache_1_1CachePeekMode-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ignite::cache::CachePeekMode Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Enumeration of all supported cache peek modes.
<a href="structignite_1_1cache_1_1CachePeekMode.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="core_2include_2ignite_2cache_2cache__peek__mode_8h_source.html">cache_peek_mode.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:acd2d0e89b2c2c9d391060a89585bc2b2"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2">Type</a> { <br />
&#160;&#160;<a class="el" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2ac963dd400d80659ced9e17f5474663c6">ALL</a> = 0x01,
<a class="el" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2a3f02efa2bb93754964406c106b1d7b9c">NEAR_CACHE</a> = 0x02,
<a class="el" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2a53c00318ef070e94f5127c7ae2c82660">PRIMARY</a> = 0x04,
<a class="el" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2aa48147b4bdb14cb334fec9e695f27745">BACKUP</a> = 0x08,
<br />
&#160;&#160;<a class="el" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2a90c9e60259353b076439b01f35089b88">ONHEAP</a> = 0x10,
<a class="el" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2a6fcb4ebe7e451e3ba4e7d9a50e1ca048">OFFHEAP</a> = 0x20,
<a class="el" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2a36ad9d80fd6d24a1353213cf770ae9eb">SWAP</a> = 0x40
<br />
}</td></tr>
<tr class="separator:acd2d0e89b2c2c9d391060a89585bc2b2"><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>Enumeration of all supported cache peek modes. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="acd2d0e89b2c2c9d391060a89585bc2b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd2d0e89b2c2c9d391060a89585bc2b2">&#9670;&nbsp;</a></span>Type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2">ignite::cache::CachePeekMode::Type</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="acd2d0e89b2c2c9d391060a89585bc2b2ac963dd400d80659ced9e17f5474663c6"></a>ALL&#160;</td><td class="fielddoc"><p>Peeks into all available cache storages. </p>
</td></tr>
<tr><td class="fieldname"><a id="acd2d0e89b2c2c9d391060a89585bc2b2a3f02efa2bb93754964406c106b1d7b9c"></a>NEAR_CACHE&#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 <a class="el" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2ac963dd400d80659ced9e17f5474663c6" title="Peeks into all available cache storages. ">CachePeekMode::ALL</a> mode. </p>
</td></tr>
<tr><td class="fieldname"><a id="acd2d0e89b2c2c9d391060a89585bc2b2a53c00318ef070e94f5127c7ae2c82660"></a>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 <a class="el" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2ac963dd400d80659ced9e17f5474663c6" title="Peeks into all available cache storages. ">CachePeekMode::ALL</a> mode. </p>
</td></tr>
<tr><td class="fieldname"><a id="acd2d0e89b2c2c9d391060a89585bc2b2aa48147b4bdb14cb334fec9e695f27745"></a>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 <a class="el" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2ac963dd400d80659ced9e17f5474663c6" title="Peeks into all available cache storages. ">CachePeekMode::ALL</a> mode. </p>
</td></tr>
<tr><td class="fieldname"><a id="acd2d0e89b2c2c9d391060a89585bc2b2a90c9e60259353b076439b01f35089b88"></a>ONHEAP&#160;</td><td class="fielddoc"><p>Peeks value from the on-heap storage only. </p>
</td></tr>
<tr><td class="fieldname"><a id="acd2d0e89b2c2c9d391060a89585bc2b2a6fcb4ebe7e451e3ba4e7d9a50e1ca048"></a>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 id="acd2d0e89b2c2c9d391060a89585bc2b2a36ad9d80fd6d24a1353213cf770ae9eb"></a>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>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="core_2include_2ignite_2cache_2cache__peek__mode_8h_source.html">core/include/ignite/cache/cache_peek_mode.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Feb 27 2020 14:01:15 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.13
</small></address>
</body>
</html>