blob: 1a4230ace9fcbb95a8bd38edd3af692941300af3 [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++: continuous_query_handle.h Source File</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="dir_1d5505cee217f179c88903b7091c150e.html">cache</a></li><li class="navelem"><a class="el" href="dir_13c1d00a1be9b016a133dec12b890b36.html">query</a></li><li class="navelem"><a class="el" href="dir_a589d7fa76191ec48a638b0021c39d11.html">continuous</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">continuous_query_handle.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="continuous__query__handle_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * this work for additional information regarding copyright ownership.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * (the &quot;License&quot;); you may not use this file except in compliance with</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * limitations under the License.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#ifndef _IGNITE_CACHE_QUERY_CONTINUOUS_CONTINUOUS_QUERY_HANDLE</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#define _IGNITE_CACHE_QUERY_CONTINUOUS_CONTINUOUS_QUERY_HANDLE</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;ignite/impl/cache/query/continuous/continuous_query_handle_impl.h&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceignite.html">ignite</a></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;{</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">namespace </span>cache</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">namespace </span>query</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; {</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">namespace </span>continuous</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; {</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> K, <span class="keyword">typename</span> V&gt;</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html"> 40</a></span>&#160; <span class="keyword">class </span><a class="code" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html">ContinuousQueryHandle</a></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; {</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#aceba2b9463abc26b5700d3d40d42dfc6"> 46</a></span>&#160; <a class="code" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#aceba2b9463abc26b5700d3d40d42dfc6">ContinuousQueryHandle</a>() :</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; impl()</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; {</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="comment">// No-op.</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; }</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#a0c961907dd05bef57a3e6261a6a54928"> 59</a></span>&#160; <a class="code" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#a0c961907dd05bef57a3e6261a6a54928">ContinuousQueryHandle</a>(impl::cache::query::continuous::ContinuousQueryHandleImpl* impl) :</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; impl(impl)</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; {</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="comment">// No-op.</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; }</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#a3b28318681cb8c395c671f9d7ce8c435"> 72</a></span>&#160; <a class="code" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">QueryCursor&lt;K, V&gt;</a> <a class="code" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#a3b28318681cb8c395c671f9d7ce8c435">GetInitialQueryCursor</a>()</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; {</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <a class="code" href="classignite_1_1IgniteError.html">IgniteError</a> err;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <a class="code" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">QueryCursor&lt;K, V&gt;</a> res = <a class="code" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#a3b28318681cb8c395c671f9d7ce8c435">GetInitialQueryCursor</a>(err);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <a class="code" href="classignite_1_1IgniteError.html#a99e9d86e40876885459a86276eccb935">IgniteError::ThrowIfNeeded</a>(err);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordflow">return</span> res;</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; }</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; </div>
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#ae9b97cec86a70afdbd7151f8997c3760"> 91</a></span>&#160; <a class="code" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">QueryCursor&lt;K, V&gt;</a> <a class="code" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#ae9b97cec86a70afdbd7151f8997c3760">GetInitialQueryCursor</a>(<a class="code" href="classignite_1_1IgniteError.html">IgniteError</a>&amp; err)</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; {</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; impl::cache::query::continuous::ContinuousQueryHandleImpl* impl0 = impl.Get();</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keywordflow">if</span> (impl0)</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">QueryCursor&lt;K, V&gt;</a>(impl0-&gt;GetInitialQueryCursor(err));</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keywordflow">else</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; {</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; err = <a class="code" href="classignite_1_1IgniteError.html">IgniteError</a>(<a class="code" href="classignite_1_1IgniteError.html#abee4f1ca9ade2b8b4d0af780feea2577">IgniteError::IGNITE_ERR_GENERIC</a>,</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="stringliteral">&quot;Instance is not usable (did you check for error?).&quot;</span>);</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classignite_1_1cache_1_1query_1_1QueryCursor.html">QueryCursor&lt;K, V&gt;</a>();</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; }</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; }</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; </div>
<div class="line"><a name="l00117"></a><span class="lineno"><a class="line" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#a90d2c6939d790a0b7d89775270b0e565"> 117</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#a90d2c6939d790a0b7d89775270b0e565">IsValid</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <span class="keywordflow">return</span> impl.IsValid();</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; }</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; </div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keyword">typedef</span> impl::cache::query::continuous::ContinuousQueryHandleImpl ContinuousQueryHandleImpl;</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; </div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; common::concurrent::SharedPointer&lt;ContinuousQueryHandleImpl&gt; impl;</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; };</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; }</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; }</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; }</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;}</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; </div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;<span class="preprocessor">#endif //_IGNITE_CACHE_QUERY_CONTINUOUS_CONTINUOUS_QUERY_HANDLE</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="anamespaceignite_html"><div class="ttname"><a href="namespaceignite.html">ignite</a></div><div class="ttdoc">Apache Ignite API.</div><div class="ttdef"><b>Definition:</b> cache.h:48</div></div>
<div class="ttc" id="aclassignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle_html_ae9b97cec86a70afdbd7151f8997c3760"><div class="ttname"><a href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#ae9b97cec86a70afdbd7151f8997c3760">ignite::cache::query::continuous::ContinuousQueryHandle::GetInitialQueryCursor</a></div><div class="ttdeci">QueryCursor&lt; K, V &gt; GetInitialQueryCursor(IgniteError &amp;err)</div><div class="ttdoc">Gets the cursor for initial query.</div><div class="ttdef"><b>Definition:</b> continuous_query_handle.h:91</div></div>
<div class="ttc" id="aclassignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle_html_a3b28318681cb8c395c671f9d7ce8c435"><div class="ttname"><a href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#a3b28318681cb8c395c671f9d7ce8c435">ignite::cache::query::continuous::ContinuousQueryHandle::GetInitialQueryCursor</a></div><div class="ttdeci">QueryCursor&lt; K, V &gt; GetInitialQueryCursor()</div><div class="ttdoc">Gets the cursor for initial query.</div><div class="ttdef"><b>Definition:</b> continuous_query_handle.h:72</div></div>
<div class="ttc" id="aclassignite_1_1cache_1_1query_1_1QueryCursor_html"><div class="ttname"><a href="classignite_1_1cache_1_1query_1_1QueryCursor.html">ignite::cache::query::QueryCursor</a></div><div class="ttdoc">Query cursor class template.</div><div class="ttdef"><b>Definition:</b> query_cursor.h:54</div></div>
<div class="ttc" id="aclassignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle_html_aceba2b9463abc26b5700d3d40d42dfc6"><div class="ttname"><a href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#aceba2b9463abc26b5700d3d40d42dfc6">ignite::cache::query::continuous::ContinuousQueryHandle::ContinuousQueryHandle</a></div><div class="ttdeci">ContinuousQueryHandle()</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> continuous_query_handle.h:46</div></div>
<div class="ttc" id="aclassignite_1_1IgniteError_html_abee4f1ca9ade2b8b4d0af780feea2577"><div class="ttname"><a href="classignite_1_1IgniteError.html#abee4f1ca9ade2b8b4d0af780feea2577">ignite::IgniteError::IGNITE_ERR_GENERIC</a></div><div class="ttdeci">static const int IGNITE_ERR_GENERIC</div><div class="ttdoc">Generic Ignite error.</div><div class="ttdef"><b>Definition:</b> ignite_error.h:131</div></div>
<div class="ttc" id="aclassignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle_html_a0c961907dd05bef57a3e6261a6a54928"><div class="ttname"><a href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#a0c961907dd05bef57a3e6261a6a54928">ignite::cache::query::continuous::ContinuousQueryHandle::ContinuousQueryHandle</a></div><div class="ttdeci">ContinuousQueryHandle(impl::cache::query::continuous::ContinuousQueryHandleImpl *impl)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> continuous_query_handle.h:59</div></div>
<div class="ttc" id="aclassignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle_html_a90d2c6939d790a0b7d89775270b0e565"><div class="ttname"><a href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html#a90d2c6939d790a0b7d89775270b0e565">ignite::cache::query::continuous::ContinuousQueryHandle::IsValid</a></div><div class="ttdeci">bool IsValid() const</div><div class="ttdoc">Check if the instance is valid.</div><div class="ttdef"><b>Definition:</b> continuous_query_handle.h:117</div></div>
<div class="ttc" id="aclassignite_1_1IgniteError_html_a99e9d86e40876885459a86276eccb935"><div class="ttname"><a href="classignite_1_1IgniteError.html#a99e9d86e40876885459a86276eccb935">ignite::IgniteError::ThrowIfNeeded</a></div><div class="ttdeci">static void ThrowIfNeeded(const IgniteError &amp;err)</div><div class="ttdoc">Throw an error if code is not IGNITE_SUCCESS.</div><div class="ttdef"><b>Definition:</b> ignite_error.cpp:27</div></div>
<div class="ttc" id="aclassignite_1_1IgniteError_html"><div class="ttname"><a href="classignite_1_1IgniteError.html">ignite::IgniteError</a></div><div class="ttdoc">Ignite error information.</div><div class="ttdef"><b>Definition:</b> ignite_error.h:94</div></div>
<div class="ttc" id="aclassignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle_html"><div class="ttname"><a href="classignite_1_1cache_1_1query_1_1continuous_1_1ContinuousQueryHandle.html">ignite::cache::query::continuous::ContinuousQueryHandle</a></div><div class="ttdoc">Continuous query handle.</div><div class="ttdef"><b>Definition:</b> continuous_query_handle.h:40</div></div>
<!-- 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>