blob: 8f3d74a7043cea3272481a0de40af359c25e8c5c [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 C++ Reference: apache::geode::client::CqStatistics Class 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 C++ 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('a00427.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::CqStatistics Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>This class provides methods to get statistical information about a registered Continuous <a class="el" href="a00807.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">Query</a> (CQ) represented by the <a class="el" href="a00415.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">CqQuery</a> object.
<a href="a00427.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:a57f77354f49ddbef336663fcf0893cb8"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00427.html#a57f77354f49ddbef336663fcf0893cb8">numDeletes</a> () const =0</td></tr>
<tr class="memdesc:a57f77354f49ddbef336663fcf0893cb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get number of Delete events qualified by this CQ. <a href="#a57f77354f49ddbef336663fcf0893cb8">More...</a><br /></td></tr>
<tr class="separator:a57f77354f49ddbef336663fcf0893cb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae46ab6d7264608ac130f979f1b6cd1ee"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00427.html#ae46ab6d7264608ac130f979f1b6cd1ee">numEvents</a> () const =0</td></tr>
<tr class="memdesc:ae46ab6d7264608ac130f979f1b6cd1ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get total of all the events qualified by this CQ. <a href="#ae46ab6d7264608ac130f979f1b6cd1ee">More...</a><br /></td></tr>
<tr class="separator:ae46ab6d7264608ac130f979f1b6cd1ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ca83f224a3aade7c6232fbc1fe26824"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00427.html#a5ca83f224a3aade7c6232fbc1fe26824">numInserts</a> () const =0</td></tr>
<tr class="memdesc:a5ca83f224a3aade7c6232fbc1fe26824"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get number of Insert events qualified by this CQ. <a href="#a5ca83f224a3aade7c6232fbc1fe26824">More...</a><br /></td></tr>
<tr class="separator:a5ca83f224a3aade7c6232fbc1fe26824"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aedfb1a9fd9a4f25f7e2d5baa5c500b70"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00427.html#aedfb1a9fd9a4f25f7e2d5baa5c500b70">numUpdates</a> () const =0</td></tr>
<tr class="memdesc:aedfb1a9fd9a4f25f7e2d5baa5c500b70"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get number of Update events qualified by this CQ. <a href="#aedfb1a9fd9a4f25f7e2d5baa5c500b70">More...</a><br /></td></tr>
<tr class="separator:aedfb1a9fd9a4f25f7e2d5baa5c500b70"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class provides methods to get statistical information about a registered Continuous <a class="el" href="a00807.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">Query</a> (CQ) represented by the <a class="el" href="a00415.html" title="A Query is obtained from a QueryService which in turn is obtained from the Cache.">CqQuery</a> object. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a57f77354f49ddbef336663fcf0893cb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57f77354f49ddbef336663fcf0893cb8">&#9670;&nbsp;</a></span>numDeletes()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint32_t apache::geode::client::CqStatistics::numDeletes </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get number of Delete events qualified by this CQ. </p>
<dl class="section return"><dt>Returns</dt><dd>number of deletes. </dd></dl>
</div>
</div>
<a id="ae46ab6d7264608ac130f979f1b6cd1ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae46ab6d7264608ac130f979f1b6cd1ee">&#9670;&nbsp;</a></span>numEvents()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint32_t apache::geode::client::CqStatistics::numEvents </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get total of all the events qualified by this CQ. </p>
<dl class="section return"><dt>Returns</dt><dd>total number of events. </dd></dl>
</div>
</div>
<a id="a5ca83f224a3aade7c6232fbc1fe26824"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ca83f224a3aade7c6232fbc1fe26824">&#9670;&nbsp;</a></span>numInserts()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint32_t apache::geode::client::CqStatistics::numInserts </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get number of Insert events qualified by this CQ. </p>
<dl class="section return"><dt>Returns</dt><dd>number of inserts. </dd></dl>
</div>
</div>
<a id="aedfb1a9fd9a4f25f7e2d5baa5c500b70"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aedfb1a9fd9a4f25f7e2d5baa5c500b70">&#9670;&nbsp;</a></span>numUpdates()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint32_t apache::geode::client::CqStatistics::numUpdates </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get number of Update events qualified by this CQ. </p>
<dl class="section return"><dt>Returns</dt><dd>number of updates. </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 API Documentation</small></address>