blob: ab870bfdea97d928880af7e7870eab62cbdcaeef [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++: ignite::cache::query::continuous::ContinuousQueryHandle&lt; K, V &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="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="namespaceignite.html">ignite</a></li><li class="navelem"><a class="el" href="namespaceignite_1_1cache.html">cache</a></li><li class="navelem"><a class="el" href="namespaceignite_1_1cache_1_1query.html">query</a></li><li class="navelem"><a class="el" href="namespaceignite_1_1cache_1_1query_1_1continuous.html">continuous</a></li><li class="navelem"><a class="el" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html">ContinuousQueryHandle</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ignite::cache::query::continuous::ContinuousQueryHandle&lt; K, V &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Continuous query handle.
<a href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="continuous__query__handle_8h_source.html">continuous_query_handle.h</a>&gt;</code></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:aceba2b9463abc26b5700d3d40d42dfc6"><td class="memItemLeft" align="right" valign="top"><a id="aceba2b9463abc26b5700d3d40d42dfc6"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#aceba2b9463abc26b5700d3d40d42dfc6">ContinuousQueryHandle</a> ()</td></tr>
<tr class="memdesc:aceba2b9463abc26b5700d3d40d42dfc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:aceba2b9463abc26b5700d3d40d42dfc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c961907dd05bef57a3e6261a6a54928"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#a0c961907dd05bef57a3e6261a6a54928">ContinuousQueryHandle</a> (impl::cache::query::continuous::ContinuousQueryHandleImpl *impl)</td></tr>
<tr class="memdesc:a0c961907dd05bef57a3e6261a6a54928"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#a0c961907dd05bef57a3e6261a6a54928">More...</a><br /></td></tr>
<tr class="separator:a0c961907dd05bef57a3e6261a6a54928"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b28318681cb8c395c671f9d7ce8c435"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">QueryCursor</a>&lt; K, V &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#a3b28318681cb8c395c671f9d7ce8c435">GetInitialQueryCursor</a> ()</td></tr>
<tr class="memdesc:a3b28318681cb8c395c671f9d7ce8c435"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the cursor for initial query. <a href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#a3b28318681cb8c395c671f9d7ce8c435">More...</a><br /></td></tr>
<tr class="separator:a3b28318681cb8c395c671f9d7ce8c435"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9b97cec86a70afdbd7151f8997c3760"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">QueryCursor</a>&lt; K, V &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#ae9b97cec86a70afdbd7151f8997c3760">GetInitialQueryCursor</a> (<a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &amp;err)</td></tr>
<tr class="memdesc:ae9b97cec86a70afdbd7151f8997c3760"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the cursor for initial query. <a href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#ae9b97cec86a70afdbd7151f8997c3760">More...</a><br /></td></tr>
<tr class="separator:ae9b97cec86a70afdbd7151f8997c3760"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90d2c6939d790a0b7d89775270b0e565"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#a90d2c6939d790a0b7d89775270b0e565">IsValid</a> () const</td></tr>
<tr class="memdesc:a90d2c6939d790a0b7d89775270b0e565"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the instance is valid. <a href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#a90d2c6939d790a0b7d89775270b0e565">More...</a><br /></td></tr>
<tr class="separator:a90d2c6939d790a0b7d89775270b0e565"><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;typename K, typename V&gt;<br />
class ignite::cache::query::continuous::ContinuousQueryHandle&lt; K, V &gt;</h3>
<p>Continuous query handle. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0c961907dd05bef57a3e6261a6a54928"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c961907dd05bef57a3e6261a6a54928">&#9670;&nbsp;</a></span>ContinuousQueryHandle()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename K , typename V &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html">ignite::cache::query::continuous::ContinuousQueryHandle</a>&lt; K, V &gt;::<a class="el" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html">ContinuousQueryHandle</a> </td>
<td>(</td>
<td class="paramtype">impl::cache::query::continuous::ContinuousQueryHandleImpl *&#160;</td>
<td class="paramname"><em>impl</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<p>Internal method. Should not be used by user.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">impl</td><td>Implementation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3b28318681cb8c395c671f9d7ce8c435"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b28318681cb8c395c671f9d7ce8c435">&#9670;&nbsp;</a></span>GetInitialQueryCursor() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename K , typename V &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">QueryCursor</a>&lt;K, V&gt; <a class="el" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html">ignite::cache::query::continuous::ContinuousQueryHandle</a>&lt; K, V &gt;::GetInitialQueryCursor </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the cursor for initial query. </p>
<p>Can be called only once, throws <a class="el" href="classignite_1_1IgniteError.html" title="Ignite error information.">IgniteError</a> on consequent calls.</p>
<dl class="section return"><dt>Returns</dt><dd>Initial query cursor. </dd></dl>
</div>
</div>
<a id="ae9b97cec86a70afdbd7151f8997c3760"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9b97cec86a70afdbd7151f8997c3760">&#9670;&nbsp;</a></span>GetInitialQueryCursor() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename K , typename V &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">QueryCursor</a>&lt;K, V&gt; <a class="el" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html">ignite::cache::query::continuous::ContinuousQueryHandle</a>&lt; K, V &gt;::GetInitialQueryCursor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &amp;&#160;</td>
<td class="paramname"><em>err</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the cursor for initial query. </p>
<p>Can be called only once, results in error on consequent calls.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">err</td><td>Error. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Initial query cursor. </dd></dl>
</div>
</div>
<a id="a90d2c6939d790a0b7d89775270b0e565"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90d2c6939d790a0b7d89775270b0e565">&#9670;&nbsp;</a></span>IsValid()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename K , typename V &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html">ignite::cache::query::continuous::ContinuousQueryHandle</a>&lt; K, V &gt;::IsValid </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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the instance is valid. </p>
<p>Invalid instance can be returned if some of the previous operations have resulted in a failure. For example invalid instance can be returned by not-throwing version of method in case of error. Invalid instances also often can be created using default constructor.</p>
<dl class="section return"><dt>Returns</dt><dd>True if the instance is valid and can be used. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="continuous__query__handle_8h_source.html">continuous_query_handle.h</a></li>
</ul>
</div><!-- contents -->
<!-- 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>