blob: 1abe90bebfa0dc40c9db1e25cda2359d1334342b [file] [log] [blame]
<!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">
<head>
<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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>&nbsp; Apache Ignite C++: cache_peek_mode.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 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.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<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_1d5505cee217f179c88903b7091c150e.html">cache</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">core/include/ignite/cache/cache_peek_mode.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="core_2include_2ignite_2cache_2cache__peek__mode_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * this work for additional information regarding copyright ownership.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * (the &quot;License&quot;); you may not use this file except in compliance with</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * limitations under the License.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#ifndef _IGNITE_CACHE_CACHE_PEEK_MODE</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#define _IGNITE_CACHE_CACHE_PEEK_MODE</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceignite.html">ignite</a></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;{</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keyword">namespace </span>cache</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; {</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="structignite_1_1cache_1_1CachePeekMode.html"> 33</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structignite_1_1cache_1_1CachePeekMode.html">CachePeekMode</a></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; {</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2"> 35</a></span>&#160; <span class="keyword">enum</span> <a class="code" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2">Type</a></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; {</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2ac963dd400d80659ced9e17f5474663c6"> 40</a></span>&#160; <a class="code" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2ac963dd400d80659ced9e17f5474663c6">ALL</a> = 0x01,</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2a3f02efa2bb93754964406c106b1d7b9c"> 46</a></span>&#160; <a class="code" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2a3f02efa2bb93754964406c106b1d7b9c">NEAR_CACHE</a> = 0x02,</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2a53c00318ef070e94f5127c7ae2c82660"> 52</a></span>&#160; <a class="code" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2a53c00318ef070e94f5127c7ae2c82660">PRIMARY</a> = 0x04,</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2aa48147b4bdb14cb334fec9e695f27745"> 58</a></span>&#160; <a class="code" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2aa48147b4bdb14cb334fec9e695f27745">BACKUP</a> = 0x08,</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2a90c9e60259353b076439b01f35089b88"> 63</a></span>&#160; <a class="code" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2a90c9e60259353b076439b01f35089b88">ONHEAP</a> = 0x10,</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2a6fcb4ebe7e451e3ba4e7d9a50e1ca048"> 68</a></span>&#160; <a class="code" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2a6fcb4ebe7e451e3ba4e7d9a50e1ca048">OFFHEAP</a> = 0x20,</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2a36ad9d80fd6d24a1353213cf770ae9eb"> 73</a></span>&#160; <a class="code" href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2a36ad9d80fd6d24a1353213cf770ae9eb">SWAP</a> = 0x40</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; };</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; };</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; }</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;}</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;<span class="preprocessor">#endif //_IGNITE_CACHE_CACHE_PEEK_MODE</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="anamespaceignite_html"><div class="ttname"><a href="namespaceignite.html">ignite</a></div><div class="ttdoc">Apache Ignite API.</div><div class="ttdef"><b>Definition:</b> cache.h:48</div></div>
<div class="ttc" id="astructignite_1_1cache_1_1CachePeekMode_html_acd2d0e89b2c2c9d391060a89585bc2b2a3f02efa2bb93754964406c106b1d7b9c"><div class="ttname"><a href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2a3f02efa2bb93754964406c106b1d7b9c">ignite::cache::CachePeekMode::NEAR_CACHE</a></div><div class="ttdeci">@ NEAR_CACHE</div><div class="ttdoc">Peek into near cache only (don't peek into partitioned cache).</div><div class="ttdef"><b>Definition:</b> core/include/ignite/cache/cache_peek_mode.h:46</div></div>
<div class="ttc" id="astructignite_1_1cache_1_1CachePeekMode_html_acd2d0e89b2c2c9d391060a89585bc2b2a90c9e60259353b076439b01f35089b88"><div class="ttname"><a href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2a90c9e60259353b076439b01f35089b88">ignite::cache::CachePeekMode::ONHEAP</a></div><div class="ttdeci">@ ONHEAP</div><div class="ttdoc">Peeks value from the on-heap storage only.</div><div class="ttdef"><b>Definition:</b> core/include/ignite/cache/cache_peek_mode.h:63</div></div>
<div class="ttc" id="astructignite_1_1cache_1_1CachePeekMode_html_acd2d0e89b2c2c9d391060a89585bc2b2a36ad9d80fd6d24a1353213cf770ae9eb"><div class="ttname"><a href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2a36ad9d80fd6d24a1353213cf770ae9eb">ignite::cache::CachePeekMode::SWAP</a></div><div class="ttdeci">@ SWAP</div><div class="ttdoc">Peeks value from the swap storage only, without loading swapped value into cache.</div><div class="ttdef"><b>Definition:</b> core/include/ignite/cache/cache_peek_mode.h:73</div></div>
<div class="ttc" id="astructignite_1_1cache_1_1CachePeekMode_html_acd2d0e89b2c2c9d391060a89585bc2b2a6fcb4ebe7e451e3ba4e7d9a50e1ca048"><div class="ttname"><a href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2a6fcb4ebe7e451e3ba4e7d9a50e1ca048">ignite::cache::CachePeekMode::OFFHEAP</a></div><div class="ttdeci">@ OFFHEAP</div><div class="ttdoc">Peeks value from the off-heap storage only, without loading off-heap value into cache.</div><div class="ttdef"><b>Definition:</b> core/include/ignite/cache/cache_peek_mode.h:68</div></div>
<div class="ttc" id="astructignite_1_1cache_1_1CachePeekMode_html_acd2d0e89b2c2c9d391060a89585bc2b2aa48147b4bdb14cb334fec9e695f27745"><div class="ttname"><a href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2aa48147b4bdb14cb334fec9e695f27745">ignite::cache::CachePeekMode::BACKUP</a></div><div class="ttdeci">@ BACKUP</div><div class="ttdoc">Peek value from backup copies of partitioned cache only (skip near cache).</div><div class="ttdef"><b>Definition:</b> core/include/ignite/cache/cache_peek_mode.h:58</div></div>
<div class="ttc" id="astructignite_1_1cache_1_1CachePeekMode_html_acd2d0e89b2c2c9d391060a89585bc2b2"><div class="ttname"><a href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2">ignite::cache::CachePeekMode::Type</a></div><div class="ttdeci">Type</div><div class="ttdef"><b>Definition:</b> core/include/ignite/cache/cache_peek_mode.h:35</div></div>
<div class="ttc" id="astructignite_1_1cache_1_1CachePeekMode_html_acd2d0e89b2c2c9d391060a89585bc2b2a53c00318ef070e94f5127c7ae2c82660"><div class="ttname"><a href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2a53c00318ef070e94f5127c7ae2c82660">ignite::cache::CachePeekMode::PRIMARY</a></div><div class="ttdeci">@ PRIMARY</div><div class="ttdoc">Peek value from primary copy of partitioned cache only (skip near cache).</div><div class="ttdef"><b>Definition:</b> core/include/ignite/cache/cache_peek_mode.h:52</div></div>
<div class="ttc" id="astructignite_1_1cache_1_1CachePeekMode_html"><div class="ttname"><a href="structignite_1_1cache_1_1CachePeekMode.html">ignite::cache::CachePeekMode</a></div><div class="ttdoc">Enumeration of all supported cache peek modes.</div><div class="ttdef"><b>Definition:</b> core/include/ignite/cache/cache_peek_mode.h:33</div></div>
<div class="ttc" id="astructignite_1_1cache_1_1CachePeekMode_html_acd2d0e89b2c2c9d391060a89585bc2b2ac963dd400d80659ced9e17f5474663c6"><div class="ttname"><a href="structignite_1_1cache_1_1CachePeekMode.html#acd2d0e89b2c2c9d391060a89585bc2b2ac963dd400d80659ced9e17f5474663c6">ignite::cache::CachePeekMode::ALL</a></div><div class="ttdeci">@ ALL</div><div class="ttdoc">Peeks into all available cache storages.</div><div class="ttdef"><b>Definition:</b> core/include/ignite/cache/cache_peek_mode.h:40</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jan 10 2022 11:02:04 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.17
</small></address>
</body>
</html>