blob: 54cad65eaee6fa4163686b9b5f328ed8bd7a8152 [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::CqEvent&lt; TKey, TResult &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.1</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('a00578.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="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Apache::Geode::Client::CqEvent&lt; TKey, TResult &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class encapsulates events that occur for cq.
<a href="a00578.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5d5047106e796542456f4126933a692b"><td class="memItemLeft" align="right" valign="top">CqOperation&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00578.html#a5d5047106e796542456f4126933a692b">getBaseOperation</a> ()</td></tr>
<tr class="memdesc:a5d5047106e796542456f4126933a692b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the operation on the base operation that triggered this event. <a href="#a5d5047106e796542456f4126933a692b">More...</a><br /></td></tr>
<tr class="separator:a5d5047106e796542456f4126933a692b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f2854b0c513d3bf4d797862246e5687"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00590.html">CqQuery</a>&lt; TKey, TResult &gt; ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00578.html#a2f2854b0c513d3bf4d797862246e5687">getCq</a> ()</td></tr>
<tr class="memdesc:a2f2854b0c513d3bf4d797862246e5687"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the cqquery this event occurred in. <a href="#a2f2854b0c513d3bf4d797862246e5687">More...</a><br /></td></tr>
<tr class="separator:a2f2854b0c513d3bf4d797862246e5687"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab240ff91e6af8b83817bee8ffb6116ac"><td class="memItemLeft" align="right" valign="top">TKey&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00578.html#ab240ff91e6af8b83817bee8ffb6116ac">getKey</a> ()</td></tr>
<tr class="memdesc:ab240ff91e6af8b83817bee8ffb6116ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the key relating to the event. <a href="#ab240ff91e6af8b83817bee8ffb6116ac">More...</a><br /></td></tr>
<tr class="separator:ab240ff91e6af8b83817bee8ffb6116ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a882cdbbe8ec1980ea577badd00d9db"><td class="memItemLeft" align="right" valign="top">TResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00578.html#a8a882cdbbe8ec1980ea577badd00d9db">getNewValue</a> ()</td></tr>
<tr class="memdesc:a8a882cdbbe8ec1980ea577badd00d9db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the new value of the modification. <a href="#a8a882cdbbe8ec1980ea577badd00d9db">More...</a><br /></td></tr>
<tr class="separator:a8a882cdbbe8ec1980ea577badd00d9db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6493a60f8e5475f7f8f57c3b148226e0"><td class="memItemLeft" align="right" valign="top">CqOperation&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00578.html#a6493a60f8e5475f7f8f57c3b148226e0">getQueryOperation</a> ()</td></tr>
<tr class="memdesc:a6493a60f8e5475f7f8f57c3b148226e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the operation on the query operation that triggered this event. <a href="#a6493a60f8e5475f7f8f57c3b148226e0">More...</a><br /></td></tr>
<tr class="separator:a6493a60f8e5475f7f8f57c3b148226e0"><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 TResult&gt;<br />
class Apache::Geode::Client::CqEvent&lt; TKey, TResult &gt;</h3>
<p>This class encapsulates events that occur for cq. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a5d5047106e796542456f4126933a692b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d5047106e796542456f4126933a692b">&#9670;&nbsp;</a></span>getBaseOperation()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey , class TResult &gt; </div>
<table class="memname">
<tr>
<td class="memname">CqOperation <a class="el" href="a00578.html">Apache::Geode::Client::CqEvent</a>&lt; TKey, TResult &gt;::getBaseOperation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the operation on the base operation that triggered this event. </p>
</div>
</div>
<a id="a2f2854b0c513d3bf4d797862246e5687"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f2854b0c513d3bf4d797862246e5687">&#9670;&nbsp;</a></span>getCq()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey , class TResult &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00590.html">CqQuery</a>&lt;TKey, TResult&gt; ^ <a class="el" href="a00578.html">Apache::Geode::Client::CqEvent</a>&lt; TKey, TResult &gt;::getCq </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the cqquery this event occurred in. </p>
</div>
</div>
<a id="ab240ff91e6af8b83817bee8ffb6116ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab240ff91e6af8b83817bee8ffb6116ac">&#9670;&nbsp;</a></span>getKey()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey , class TResult &gt; </div>
<table class="memname">
<tr>
<td class="memname">TKey <a class="el" href="a00578.html">Apache::Geode::Client::CqEvent</a>&lt; TKey, TResult &gt;::getKey </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the key relating to the event. </p>
<p>In case of REGION_CLEAR and REGION_INVALIDATE operation, the key will be null. </p>
</div>
</div>
<a id="a8a882cdbbe8ec1980ea577badd00d9db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a882cdbbe8ec1980ea577badd00d9db">&#9670;&nbsp;</a></span>getNewValue()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey , class TResult &gt; </div>
<table class="memname">
<tr>
<td class="memname">TResult <a class="el" href="a00578.html">Apache::Geode::Client::CqEvent</a>&lt; TKey, TResult &gt;::getNewValue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the new value of the modification. </p>
<p>If there is no new value returns null, this will happen during delete operation. </p>
</div>
</div>
<a id="a6493a60f8e5475f7f8f57c3b148226e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6493a60f8e5475f7f8f57c3b148226e0">&#9670;&nbsp;</a></span>getQueryOperation()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TKey , class TResult &gt; </div>
<table class="memname">
<tr>
<td class="memname">CqOperation <a class="el" href="a00578.html">Apache::Geode::Client::CqEvent</a>&lt; TKey, TResult &gt;::getQueryOperation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the operation on the query operation that triggered this event. </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>