| <!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.15"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Apache Geode Native .NET Reference: Apache::Geode::Client::RegionEntry< TKey, TValue > Class Template 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="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(initResizable); |
| /* @license-end */</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="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Apache Geode Native .NET Reference |
|  <span id="projectnumber">1.13.0</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.15 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&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> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('a01006.html','');}); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- 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 class="header"> |
| <div class="summary"> |
| <a href="#properties">Properties</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache::Geode::Client::RegionEntry< TKey, TValue > Class Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>An object in a region that represents an <em>entry</em>, that is, a key-value pair. |
| <a href="a01006.html#details">More...</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:adc481fe274d2c706addcce748abae9ae"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01006.html#adc481fe274d2c706addcce748abae9ae">IsDestroyed</a><code> [get]</code></td></tr> |
| <tr class="memdesc:adc481fe274d2c706addcce748abae9ae"><td class="mdescLeft"> </td><td class="mdescRight">True if this entry has been destroyed. <a href="#adc481fe274d2c706addcce748abae9ae">More...</a><br /></td></tr> |
| <tr class="separator:adc481fe274d2c706addcce748abae9ae"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2261b8deed86003e99b32e9bc530436a"><td class="memItemLeft" align="right" valign="top">TKey </td><td class="memItemRight" valign="bottom"><a class="el" href="a01006.html#a2261b8deed86003e99b32e9bc530436a">Key</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a2261b8deed86003e99b32e9bc530436a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the key for this entry. <a href="#a2261b8deed86003e99b32e9bc530436a">More...</a><br /></td></tr> |
| <tr class="separator:a2261b8deed86003e99b32e9bc530436a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afd6ac020850a5d8d6cd339107a2e3866"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a01014.html">IRegion</a>< TKey, TValue >^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a01006.html#afd6ac020850a5d8d6cd339107a2e3866">Region</a><code> [get]</code></td></tr> |
| <tr class="memdesc:afd6ac020850a5d8d6cd339107a2e3866"><td class="mdescLeft"> </td><td class="mdescRight">Returns the region that contains this entry. <a href="#afd6ac020850a5d8d6cd339107a2e3866">More...</a><br /></td></tr> |
| <tr class="separator:afd6ac020850a5d8d6cd339107a2e3866"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a04068863336b06037ac35f3ab291d815"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00546.html">Apache::Geode::Client::CacheStatistics</a>^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a01006.html#a04068863336b06037ac35f3ab291d815">Statistics</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a04068863336b06037ac35f3ab291d815"><td class="mdescLeft"> </td><td class="mdescRight">Returns the statistics for this entry. <a href="#a04068863336b06037ac35f3ab291d815">More...</a><br /></td></tr> |
| <tr class="separator:a04068863336b06037ac35f3ab291d815"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae4e0d3dce750509a2f3a9608fc3fba2d"><td class="memItemLeft" align="right" valign="top">TValue </td><td class="memItemRight" valign="bottom"><a class="el" href="a01006.html#ae4e0d3dce750509a2f3a9608fc3fba2d">Value</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ae4e0d3dce750509a2f3a9608fc3fba2d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the value of this entry in the local cache. <a href="#ae4e0d3dce750509a2f3a9608fc3fba2d">More...</a><br /></td></tr> |
| <tr class="separator:ae4e0d3dce750509a2f3a9608fc3fba2d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><h3>template<class TKey, class TValue><br /> |
| class Apache::Geode::Client::RegionEntry< TKey, TValue ></h3> |
| |
| <p>An object in a region that represents an <em>entry</em>, that is, a key-value pair. </p> |
| <p>This object's operations are not distributed, do not acquire any locks, and do not affect <code><a class="el" href="a00546.html" title="Defines common statistical information for both the region and its entries.">CacheStatistics</a></code>.</p> |
| <p>Unless otherwise noted, all of these methods throw a <code><a class="el" href="a00666.html" title="Thrown when an operation is attempted on a closed cache.">CacheClosedException</a></code> if the cache is closed at the time of invocation, or an <code><a class="el" href="a00682.html" title="Thrown when an operation is attempted on a destroyed entry.">EntryDestroyedException</a></code> if the entry has been destroyed.</p> |
| <p>Call <a class="el" href="a01006.html#adc481fe274d2c706addcce748abae9ae" title="True if this entry has been destroyed.">IsDestroyed</a> to see if an entry has already been destroyed. </p> |
| </div><h2 class="groupheader">Property Documentation</h2> |
| <a id="adc481fe274d2c706addcce748abae9ae"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adc481fe274d2c706addcce748abae9ae">◆ </a></span>IsDestroyed</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool <a class="el" href="a01006.html">Apache::Geode::Client::RegionEntry</a>< TKey, TValue >::IsDestroyed</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>True if this entry has been destroyed. </p> |
| <p>Does not throw a <code><a class="el" href="a00682.html" title="Thrown when an operation is attempted on a destroyed entry.">EntryDestroyedException</a></code> if this entry has been destroyed. </p> |
| <dl class="section return"><dt>Returns</dt><dd>true if this entry has been destroyed</dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00666.html" title="Thrown when an operation is attempted on a closed cache.">CacheClosedException</a></td><td>if the cache is closed at the time of invocation </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a2261b8deed86003e99b32e9bc530436a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2261b8deed86003e99b32e9bc530436a">◆ </a></span>Key</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">TKey <a class="el" href="a01006.html">Apache::Geode::Client::RegionEntry</a>< TKey, TValue >::Key</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the key for this entry. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the key for this entry</dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00666.html" title="Thrown when an operation is attempted on a closed cache.">CacheClosedException</a></td><td>if the cache is closed at the time of invocation </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00682.html" title="Thrown when an operation is attempted on a destroyed entry.">EntryDestroyedException</a></td><td>if the entry has been destroyed </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="afd6ac020850a5d8d6cd339107a2e3866"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afd6ac020850a5d8d6cd339107a2e3866">◆ </a></span>Region</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="a01014.html">IRegion</a>< TKey, TValue>^ <a class="el" href="a01006.html">Apache::Geode::Client::RegionEntry</a>< TKey, TValue >::Region</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the region that contains this entry. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the region that contains this entry</dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00666.html" title="Thrown when an operation is attempted on a closed cache.">CacheClosedException</a></td><td>if the cache is closed at the time of invocation </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00682.html" title="Thrown when an operation is attempted on a destroyed entry.">EntryDestroyedException</a></td><td>if the entry has been destroyed </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a04068863336b06037ac35f3ab291d815"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a04068863336b06037ac35f3ab291d815">◆ </a></span>Statistics</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Apache:: Geode:: Client:: <a class="el" href="a00546.html">CacheStatistics</a>^ <a class="el" href="a01006.html">Apache::Geode::Client::RegionEntry</a>< TKey, TValue >::Statistics</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the statistics for this entry. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the <a class="el" href="a00546.html" title="Defines common statistical information for both the region and its entries.">CacheStatistics</a> for this entry</dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00706.html" title="Thrown when statistics are invoked for a region where they are disabled.">StatisticsDisabledException</a></td><td>if statistics have been disabled for this region </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ae4e0d3dce750509a2f3a9608fc3fba2d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae4e0d3dce750509a2f3a9608fc3fba2d">◆ </a></span>Value</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<class TKey , class TValue > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">TValue <a class="el" href="a01006.html">Apache::Geode::Client::RegionEntry</a>< TKey, TValue >::Value</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the value of this entry in the local cache. </p> |
| <p>Does not invoke an <code><a class="el" href="a00914.html" title="A data-loading application plug-in that can be installed on a region.">ICacheLoader</a></code>, does not do a netSearch, netLoad, etc. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the value, or null if this entry is invalid – see <a class="el" href="a01006.html#adc481fe274d2c706addcce748abae9ae" title="True if this entry has been destroyed.">IsDestroyed</a> </dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00666.html" title="Thrown when an operation is attempted on a closed cache.">CacheClosedException</a></td><td>if the cache is closed at the time of invocation </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00682.html" title="Thrown when an operation is attempted on a destroyed entry.">EntryDestroyedException</a></td><td>if the entry has been destroyed </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| http://www.apache.org/licenses/LICENSE-2.0 |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <HR><address style="align: right;"><small>Apache Geode C++ Cache .NET API Documentation</small></address> |
