blob: 6da753d3ca6143addfc88cdc22da3395f1a70c95 [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::IResultCollector&lt; 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('a00874.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::IResultCollector&lt; TResult &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>collect function execution results, can be overriden
<a href="a00874.html#details">More...</a></p>
<p>Inherited by <a class="el" href="a00878.html">Apache::Geode::Client::ResultCollector&lt; TResult &gt;</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:af6e1a82feffd98f1859ed44576d00139"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00874.html#af6e1a82feffd98f1859ed44576d00139">AddResult</a> (const TResult rs)</td></tr>
<tr class="memdesc:af6e1a82feffd98f1859ed44576d00139"><td class="mdescLeft">&#160;</td><td class="mdescRight">add result from a single function execution <a href="#af6e1a82feffd98f1859ed44576d00139">More...</a><br /></td></tr>
<tr class="separator:af6e1a82feffd98f1859ed44576d00139"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4068042e82e41ae20a4e413e295f81ac"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00874.html#a4068042e82e41ae20a4e413e295f81ac">ClearResults</a> ()</td></tr>
<tr class="memdesc:a4068042e82e41ae20a4e413e295f81ac"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> will invoke this method before re-executing function (in case of Function <a class="el" href="a00882.html" title="This class encapsulates events that occur for cq.">Execution</a> HA) This is to clear the previous execution results from the result collector <a href="#a4068042e82e41ae20a4e413e295f81ac">More...</a><br /></td></tr>
<tr class="separator:a4068042e82e41ae20a4e413e295f81ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab22794001620530e9033c1e06bb74a37"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00874.html#ab22794001620530e9033c1e06bb74a37">EndResults</a> ()</td></tr>
<tr class="memdesc:ab22794001620530e9033c1e06bb74a37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Call back provided to caller, which is called after function execution is complete and caller can retrieve results using getResult() <a href="#ab22794001620530e9033c1e06bb74a37">More...</a><br /></td></tr>
<tr class="separator:ab22794001620530e9033c1e06bb74a37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e2b65467e387bff462d00f26d505ce7"><td class="memItemLeft" align="right" valign="top">System::Collections::Generic::ICollection&lt; TResult &gt; ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00874.html#a9e2b65467e387bff462d00f26d505ce7">GetResult</a> ()</td></tr>
<tr class="memdesc:a9e2b65467e387bff462d00f26d505ce7"><td class="mdescLeft">&#160;</td><td class="mdescRight">get result <a href="#a9e2b65467e387bff462d00f26d505ce7">More...</a><br /></td></tr>
<tr class="separator:a9e2b65467e387bff462d00f26d505ce7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2dff5a8dc308c8ff9cbb9e4f4cfb8e7"><td class="memItemLeft" align="right" valign="top">System::Collections::Generic::ICollection&lt; TResult &gt; ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00874.html#ad2dff5a8dc308c8ff9cbb9e4f4cfb8e7">GetResult</a> (TimeSpan timeout)</td></tr>
<tr class="memdesc:ad2dff5a8dc308c8ff9cbb9e4f4cfb8e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">get result <a href="#ad2dff5a8dc308c8ff9cbb9e4f4cfb8e7">More...</a><br /></td></tr>
<tr class="separator:ad2dff5a8dc308c8ff9cbb9e4f4cfb8e7"><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 TResult&gt;<br />
class Apache::Geode::Client::IResultCollector&lt; TResult &gt;</h3>
<p>collect function execution results, can be overriden </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="af6e1a82feffd98f1859ed44576d00139"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6e1a82feffd98f1859ed44576d00139">&#9670;&nbsp;</a></span>AddResult()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TResult &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00874.html">Apache::Geode::Client::IResultCollector</a>&lt; TResult &gt;::AddResult </td>
<td>(</td>
<td class="paramtype">const TResult&#160;</td>
<td class="paramname"><em>rs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>add result from a single function execution </p>
</div>
</div>
<a id="a4068042e82e41ae20a4e413e295f81ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4068042e82e41ae20a4e413e295f81ac">&#9670;&nbsp;</a></span>ClearResults()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TResult &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00874.html">Apache::Geode::Client::IResultCollector</a>&lt; TResult &gt;::ClearResults </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> will invoke this method before re-executing function (in case of Function <a class="el" href="a00882.html" title="This class encapsulates events that occur for cq.">Execution</a> HA) This is to clear the previous execution results from the result collector </p>
<dl class="section since"><dt>Since</dt><dd>6.5 </dd></dl>
</div>
</div>
<a id="ab22794001620530e9033c1e06bb74a37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab22794001620530e9033c1e06bb74a37">&#9670;&nbsp;</a></span>EndResults()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TResult &gt; </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00874.html">Apache::Geode::Client::IResultCollector</a>&lt; TResult &gt;::EndResults </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Call back provided to caller, which is called after function execution is complete and caller can retrieve results using getResult() </p>
</div>
</div>
<a id="a9e2b65467e387bff462d00f26d505ce7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e2b65467e387bff462d00f26d505ce7">&#9670;&nbsp;</a></span>GetResult() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TResult &gt; </div>
<table class="memname">
<tr>
<td class="memname">System::Collections::Generic::ICollection&lt;TResult&gt; ^ <a class="el" href="a00874.html">Apache::Geode::Client::IResultCollector</a>&lt; TResult &gt;::GetResult </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get result </p>
</div>
</div>
<a id="ad2dff5a8dc308c8ff9cbb9e4f4cfb8e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2dff5a8dc308c8ff9cbb9e4f4cfb8e7">&#9670;&nbsp;</a></span>GetResult() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TResult &gt; </div>
<table class="memname">
<tr>
<td class="memname">System::Collections::Generic::ICollection&lt;TResult&gt; ^ <a class="el" href="a00874.html">Apache::Geode::Client::IResultCollector</a>&lt; TResult &gt;::GetResult </td>
<td>(</td>
<td class="paramtype">TimeSpan&#160;</td>
<td class="paramname"><em>timeout</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get result </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>