blob: 7d3e472d60fdf22a27a3e78c89576a6efbc60f8c [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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Apache Geode Native .NET Reference: Apache::Geode::Client::EntryEvent&lt; TKey, TValue &gt; 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&amp;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
&#160;<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&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>
</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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('a00618.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::EntryEvent&lt; TKey, TValue &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class encapsulates events that occur for an entry in a region.
<a href="a00618.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:a9afce4fd27890ccf404b4df3bbeed5a5"><td class="memItemLeft" align="right" valign="top">Object^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00618.html#a9afce4fd27890ccf404b4df3bbeed5a5">CallbackArgument</a><code> [get]</code></td></tr>
<tr class="memdesc:a9afce4fd27890ccf404b4df3bbeed5a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the callbackArgument passed to the method that generated this event. <a href="#a9afce4fd27890ccf404b4df3bbeed5a5">More...</a><br /></td></tr>
<tr class="separator:a9afce4fd27890ccf404b4df3bbeed5a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac208f4eab312eb4df9ffb5af317e2eb7"><td class="memItemLeft" align="right" valign="top">TKey&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00618.html#ac208f4eab312eb4df9ffb5af317e2eb7">Key</a><code> [get]</code></td></tr>
<tr class="memdesc:ac208f4eab312eb4df9ffb5af317e2eb7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the key this event describes. <a href="#ac208f4eab312eb4df9ffb5af317e2eb7">More...</a><br /></td></tr>
<tr class="separator:ac208f4eab312eb4df9ffb5af317e2eb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbcd956ffa0bc3cc322f7ff5df02e544"><td class="memItemLeft" align="right" valign="top">TValue&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00618.html#acbcd956ffa0bc3cc322f7ff5df02e544">NewValue</a><code> [get]</code></td></tr>
<tr class="memdesc:acbcd956ffa0bc3cc322f7ff5df02e544"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the updated value from this event. <a href="#acbcd956ffa0bc3cc322f7ff5df02e544">More...</a><br /></td></tr>
<tr class="separator:acbcd956ffa0bc3cc322f7ff5df02e544"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab62d78e9c6e0d238cae281e1461c4d43"><td class="memItemLeft" align="right" valign="top">TValue&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00618.html#ab62d78e9c6e0d238cae281e1461c4d43">OldValue</a><code> [get]</code></td></tr>
<tr class="memdesc:ab62d78e9c6e0d238cae281e1461c4d43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns 'null' if there was no value in the cache. <a href="#ab62d78e9c6e0d238cae281e1461c4d43">More...</a><br /></td></tr>
<tr class="separator:ab62d78e9c6e0d238cae281e1461c4d43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bb34d0faf80e5b76593b53abd36c066"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a01014.html">IRegion</a>&lt; TKey, TValue &gt;^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00618.html#a4bb34d0faf80e5b76593b53abd36c066">Region</a><code> [get]</code></td></tr>
<tr class="memdesc:a4bb34d0faf80e5b76593b53abd36c066"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the region this event occurred in. <a href="#a4bb34d0faf80e5b76593b53abd36c066">More...</a><br /></td></tr>
<tr class="separator:a4bb34d0faf80e5b76593b53abd36c066"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac06b930a909ada8786f429f96a448e0e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00618.html#ac06b930a909ada8786f429f96a448e0e">RemoteOrigin</a><code> [get]</code></td></tr>
<tr class="memdesc:ac06b930a909ada8786f429f96a448e0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the event originated in a remote process, returns true. <a href="#ac06b930a909ada8786f429f96a448e0e">More...</a><br /></td></tr>
<tr class="separator:ac06b930a909ada8786f429f96a448e0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class TKey, class TValue&gt;<br />
class Apache::Geode::Client::EntryEvent&lt; TKey, TValue &gt;</h3>
<p>This class encapsulates events that occur for an entry in a region. </p>
</div><h2 class="groupheader">Property Documentation</h2>
<a id="a9afce4fd27890ccf404b4df3bbeed5a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9afce4fd27890ccf404b4df3bbeed5a5">&#9670;&nbsp;</a></span>CallbackArgument</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey , class TValue &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Object^ <a class="el" href="a00618.html">Apache::Geode::Client::EntryEvent</a>&lt; TKey, TValue &gt;::CallbackArgument</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 callbackArgument passed to the method that generated this event. </p>
<p>See the <a class="el" href="a00618.html#a4bb34d0faf80e5b76593b53abd36c066" title="Return the region this event occurred in.">Region</a> interface methods that take a callbackArgument parameter. </p>
</div>
</div>
<a id="ac208f4eab312eb4df9ffb5af317e2eb7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac208f4eab312eb4df9ffb5af317e2eb7">&#9670;&nbsp;</a></span>Key</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey , class TValue &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">TKey <a class="el" href="a00618.html">Apache::Geode::Client::EntryEvent</a>&lt; TKey, TValue &gt;::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 this event describes. </p>
</div>
</div>
<a id="acbcd956ffa0bc3cc322f7ff5df02e544"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbcd956ffa0bc3cc322f7ff5df02e544">&#9670;&nbsp;</a></span>NewValue</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey , class TValue &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">TValue <a class="el" href="a00618.html">Apache::Geode::Client::EntryEvent</a>&lt; TKey, TValue &gt;::NewValue</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>Return the updated value from this event. </p>
<p>If the event is a destroy or invalidate operation, then the new value will be NULL. </p>
</div>
</div>
<a id="ab62d78e9c6e0d238cae281e1461c4d43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab62d78e9c6e0d238cae281e1461c4d43">&#9670;&nbsp;</a></span>OldValue</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey , class TValue &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">TValue <a class="el" href="a00618.html">Apache::Geode::Client::EntryEvent</a>&lt; TKey, TValue &gt;::OldValue</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 'null' if there was no value in the cache. </p>
<p>If the prior state of the entry was invalid, or non-existent/destroyed, then the old value will be 'null'. </p>
</div>
</div>
<a id="a4bb34d0faf80e5b76593b53abd36c066"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bb34d0faf80e5b76593b53abd36c066">&#9670;&nbsp;</a></span>Region</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey , class TValue &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a01014.html">IRegion</a>&lt; TKey, TValue&gt;^ <a class="el" href="a00618.html">Apache::Geode::Client::EntryEvent</a>&lt; TKey, TValue &gt;::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>Return the region this event occurred in. </p>
</div>
</div>
<a id="ac06b930a909ada8786f429f96a448e0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac06b930a909ada8786f429f96a448e0e">&#9670;&nbsp;</a></span>RemoteOrigin</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey , class TValue &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="a00618.html">Apache::Geode::Client::EntryEvent</a>&lt; TKey, TValue &gt;::RemoteOrigin</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>If the event originated in a remote process, returns true. </p>
</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>