Google Git
Sign in
apache / ignite-website / 372257fe483ecaf031bfad76800308d2eed57097 / . / releases / 2.12.0 / cppdoc / thin-client_2include_2ignite_2thin_2cache_2cache__peek__mode_8h_source.html
blob: 515d05c6f8caf7ec6f81110a287db86c43e70ae0 [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_6917c354dff0dc051d18bd3bcc3faea1.html">include</a></li><li class="navelem"><a class="el" href="dir_3785354546cb37560a212b468c73f89f.html">ignite</a></li><li class="navelem"><a class="el" href="dir_097f68cb7241bfc683e7bdc6c58a7783.html">thin</a></li><li class="navelem"><a class="el" href="dir_4c59fe678b7d839a2941d6346d743aa7.html">cache</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">thin-client/include/ignite/thin/cache/cache_peek_mode.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="thin-client_2include_2ignite_2thin_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_IMPL_THIN_CACHE_CACHE_PEEK_MODE</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#define _IGNITE_IMPL_THIN_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>thin</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">namespace </span>cache</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; {</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html"> 35</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html">CachePeekMode</a></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; {</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html#a272b97468acc45f2b16d89c65e9891c6"> 37</a></span>&#160; <span class="keyword">enum</span> <a class="code" href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html#a272b97468acc45f2b16d89c65e9891c6">Type</a></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; {</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html#a272b97468acc45f2b16d89c65e9891c6a8c93b9244a045bfadca274d54ed70723"> 42</a></span>&#160; <a class="code" href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html#a272b97468acc45f2b16d89c65e9891c6a8c93b9244a045bfadca274d54ed70723">ALL</a> = 0x01,</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; </div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html#a272b97468acc45f2b16d89c65e9891c6aedf964c5bd3408b0eccdf5f0363c8378"> 48</a></span>&#160; <a class="code" href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html#a272b97468acc45f2b16d89c65e9891c6aedf964c5bd3408b0eccdf5f0363c8378">NEAR_CACHE</a> = 0x02,</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html#a272b97468acc45f2b16d89c65e9891c6aae46af574187058fdafbd37b229b1277"> 54</a></span>&#160; <a class="code" href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html#a272b97468acc45f2b16d89c65e9891c6aae46af574187058fdafbd37b229b1277">PRIMARY</a> = 0x04,</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html#a272b97468acc45f2b16d89c65e9891c6a8fbf1665d02c210075a7bc20f1187518"> 60</a></span>&#160; <a class="code" href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html#a272b97468acc45f2b16d89c65e9891c6a8fbf1665d02c210075a7bc20f1187518">BACKUP</a> = 0x08,</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html#a272b97468acc45f2b16d89c65e9891c6aa452d50726bc7501d603df3fda16384d"> 65</a></span>&#160; <a class="code" href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html#a272b97468acc45f2b16d89c65e9891c6aa452d50726bc7501d603df3fda16384d">ONHEAP</a> = 0x10,</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html#a272b97468acc45f2b16d89c65e9891c6ae8956cada27a4a05c389798d82f73eff"> 70</a></span>&#160; <a class="code" href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html#a272b97468acc45f2b16d89c65e9891c6ae8956cada27a4a05c389798d82f73eff">OFFHEAP</a> = 0x20</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; };</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; };</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; }</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;<span class="preprocessor">#endif //_IGNITE_IMPL_THIN_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_1thin_1_1cache_1_1CachePeekMode_html_a272b97468acc45f2b16d89c65e9891c6aa452d50726bc7501d603df3fda16384d"><div class="ttname"><a href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html#a272b97468acc45f2b16d89c65e9891c6aa452d50726bc7501d603df3fda16384d">ignite::thin::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> thin-client/include/ignite/thin/cache/cache_peek_mode.h:65</div></div>
<div class="ttc" id="astructignite_1_1thin_1_1cache_1_1CachePeekMode_html"><div class="ttname"><a href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html">ignite::thin::cache::CachePeekMode</a></div><div class="ttdoc">Enumeration of all supported cache peek modes.</div><div class="ttdef"><b>Definition:</b> thin-client/include/ignite/thin/cache/cache_peek_mode.h:35</div></div>
<div class="ttc" id="astructignite_1_1thin_1_1cache_1_1CachePeekMode_html_a272b97468acc45f2b16d89c65e9891c6ae8956cada27a4a05c389798d82f73eff"><div class="ttname"><a href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html#a272b97468acc45f2b16d89c65e9891c6ae8956cada27a4a05c389798d82f73eff">ignite::thin::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> thin-client/include/ignite/thin/cache/cache_peek_mode.h:70</div></div>
<div class="ttc" id="astructignite_1_1thin_1_1cache_1_1CachePeekMode_html_a272b97468acc45f2b16d89c65e9891c6"><div class="ttname"><a href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html#a272b97468acc45f2b16d89c65e9891c6">ignite::thin::cache::CachePeekMode::Type</a></div><div class="ttdeci">Type</div><div class="ttdef"><b>Definition:</b> thin-client/include/ignite/thin/cache/cache_peek_mode.h:37</div></div>
<div class="ttc" id="astructignite_1_1thin_1_1cache_1_1CachePeekMode_html_a272b97468acc45f2b16d89c65e9891c6a8c93b9244a045bfadca274d54ed70723"><div class="ttname"><a href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html#a272b97468acc45f2b16d89c65e9891c6a8c93b9244a045bfadca274d54ed70723">ignite::thin::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> thin-client/include/ignite/thin/cache/cache_peek_mode.h:42</div></div>
<div class="ttc" id="astructignite_1_1thin_1_1cache_1_1CachePeekMode_html_a272b97468acc45f2b16d89c65e9891c6aae46af574187058fdafbd37b229b1277"><div class="ttname"><a href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html#a272b97468acc45f2b16d89c65e9891c6aae46af574187058fdafbd37b229b1277">ignite::thin::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> thin-client/include/ignite/thin/cache/cache_peek_mode.h:54</div></div>
<div class="ttc" id="astructignite_1_1thin_1_1cache_1_1CachePeekMode_html_a272b97468acc45f2b16d89c65e9891c6aedf964c5bd3408b0eccdf5f0363c8378"><div class="ttname"><a href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html#a272b97468acc45f2b16d89c65e9891c6aedf964c5bd3408b0eccdf5f0363c8378">ignite::thin::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> thin-client/include/ignite/thin/cache/cache_peek_mode.h:48</div></div>
<div class="ttc" id="astructignite_1_1thin_1_1cache_1_1CachePeekMode_html_a272b97468acc45f2b16d89c65e9891c6a8fbf1665d02c210075a7bc20f1187518"><div class="ttname"><a href="structignite_1_1thin_1_1cache_1_1CachePeekMode.html#a272b97468acc45f2b16d89c65e9891c6a8fbf1665d02c210075a7bc20f1187518">ignite::thin::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> thin-client/include/ignite/thin/cache/cache_peek_mode.h:60</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>