blob: 77360fbbd590d3150b7e2e1370960a4b6c822cfe [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::FunctionService&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.0</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('a00890.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-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Apache::Geode::Client::FunctionService&lt; TResult &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A factory class used to create Execute object for function execution
<a href="a00890.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a83b57f83b4747f1d38d70a25c1cfd37f"><td class="memTemplParams" colspan="2">template&lt;class TKey , class TValue &gt; </td></tr>
<tr class="memitem:a83b57f83b4747f1d38d70a25c1cfd37f"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="a00882.html">Execution</a>&lt; TResult &gt; ^&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00890.html#a83b57f83b4747f1d38d70a25c1cfd37f">OnRegion</a> (<a class="el" href="a01014.html">IRegion</a>&lt; TKey, TValue &gt;^ rg)</td></tr>
<tr class="memdesc:a83b57f83b4747f1d38d70a25c1cfd37f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new region <a class="el" href="a00882.html" title="This class encapsulates events that occur for cq.">Execution</a> object <a href="#a83b57f83b4747f1d38d70a25c1cfd37f">More...</a><br /></td></tr>
<tr class="separator:a83b57f83b4747f1d38d70a25c1cfd37f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2e473877aa6aca5c0a89cdfe5cbf2f8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00882.html">Execution</a>&lt; TResult &gt; ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00890.html#aa2e473877aa6aca5c0a89cdfe5cbf2f8">OnServer</a> (<a class="el" href="a01070.html">Pool</a>^ pl)</td></tr>
<tr class="memdesc:aa2e473877aa6aca5c0a89cdfe5cbf2f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="a00882.html" title="This class encapsulates events that occur for cq.">Execution</a> object on one server <a href="#aa2e473877aa6aca5c0a89cdfe5cbf2f8">More...</a><br /></td></tr>
<tr class="separator:aa2e473877aa6aca5c0a89cdfe5cbf2f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa11fbb4cf9bd048b8d249a88b24a3473"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00882.html">Execution</a>&lt; TResult &gt; ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00890.html#aa11fbb4cf9bd048b8d249a88b24a3473">OnServer</a> (<a class="el" href="a01018.html">IRegionService</a>^ cache)</td></tr>
<tr class="memdesc:aa11fbb4cf9bd048b8d249a88b24a3473"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="a00882.html" title="This class encapsulates events that occur for cq.">Execution</a> object on one server. <a href="#aa11fbb4cf9bd048b8d249a88b24a3473">More...</a><br /></td></tr>
<tr class="separator:aa11fbb4cf9bd048b8d249a88b24a3473"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac71d9a2c6ac3649263bc5a56c3089082"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00882.html">Execution</a>&lt; TResult &gt; ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00890.html#ac71d9a2c6ac3649263bc5a56c3089082">OnServers</a> (<a class="el" href="a01070.html">Pool</a>^ pl)</td></tr>
<tr class="memdesc:ac71d9a2c6ac3649263bc5a56c3089082"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="a00882.html" title="This class encapsulates events that occur for cq.">Execution</a> object on all servers in the pool <a href="#ac71d9a2c6ac3649263bc5a56c3089082">More...</a><br /></td></tr>
<tr class="separator:ac71d9a2c6ac3649263bc5a56c3089082"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ad1d9928df454ec7e78b198558df8c9"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00882.html">Execution</a>&lt; TResult &gt; ^&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00890.html#a9ad1d9928df454ec7e78b198558df8c9">OnServers</a> (<a class="el" href="a01018.html">IRegionService</a>^ cache)</td></tr>
<tr class="memdesc:a9ad1d9928df454ec7e78b198558df8c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="a00882.html" title="This class encapsulates events that occur for cq.">Execution</a> object on all servers in the pool. <a href="#a9ad1d9928df454ec7e78b198558df8c9">More...</a><br /></td></tr>
<tr class="separator:a9ad1d9928df454ec7e78b198558df8c9"><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::FunctionService&lt; TResult &gt;</h3>
<p>A factory class used to create Execute object for function execution </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a83b57f83b4747f1d38d70a25c1cfd37f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83b57f83b4747f1d38d70a25c1cfd37f">&#9670;&nbsp;</a></span>OnRegion()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TResult &gt; </div>
<div class="memtemplate">
template&lt;class TKey , class TValue &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00882.html">Execution</a>&lt;TResult&gt; ^ <a class="el" href="a00890.html">Apache::Geode::Client::FunctionService</a>&lt; TResult &gt;::OnRegion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01014.html">IRegion</a>&lt; TKey, TValue &gt;^&#160;</td>
<td class="paramname"><em>rg</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new region <a class="el" href="a00882.html" title="This class encapsulates events that occur for cq.">Execution</a> object </p>
<p>If <a class="el" href="a01070.html" title="A pool of connections.">Pool</a> is multiusersecure mode then one need to pass logical instance of Region Pool-&gt;CreateSecureUserCache(&lt;credentials&gt;)-&gt;getRegion(&lt;regionPath&gt;). </p>
</div>
</div>
<a id="aa2e473877aa6aca5c0a89cdfe5cbf2f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2e473877aa6aca5c0a89cdfe5cbf2f8">&#9670;&nbsp;</a></span>OnServer() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TResult &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00882.html">Execution</a>&lt;TResult&gt; ^ <a class="el" href="a00890.html">Apache::Geode::Client::FunctionService</a>&lt; TResult &gt;::OnServer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01070.html">Pool</a>^&#160;</td>
<td class="paramname"><em>pl</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new <a class="el" href="a00882.html" title="This class encapsulates events that occur for cq.">Execution</a> object on one server </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00702.html" title="Thrown when an operation unsupported by the current configuration is attempted.">UnsupportedOperationException</a></td><td>unsupported operation exception, when <a class="el" href="a01070.html" title="A pool of connections.">Pool</a> is in multiusersecure mode.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa11fbb4cf9bd048b8d249a88b24a3473"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa11fbb4cf9bd048b8d249a88b24a3473">&#9670;&nbsp;</a></span>OnServer() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TResult &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00882.html">Execution</a>&lt;TResult&gt; ^ <a class="el" href="a00890.html">Apache::Geode::Client::FunctionService</a>&lt; TResult &gt;::OnServer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01018.html">IRegionService</a>^&#160;</td>
<td class="paramname"><em>cache</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new <a class="el" href="a00882.html" title="This class encapsulates events that occur for cq.">Execution</a> object on one server. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00638.html" title="Thrown when the state of cache is manipulated to be illegal.">IllegalStateException</a></td><td>when <a class="el" href="a01070.html" title="A pool of connections.">Pool</a> has been closed.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac71d9a2c6ac3649263bc5a56c3089082"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac71d9a2c6ac3649263bc5a56c3089082">&#9670;&nbsp;</a></span>OnServers() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TResult &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00882.html">Execution</a>&lt;TResult&gt; ^ <a class="el" href="a00890.html">Apache::Geode::Client::FunctionService</a>&lt; TResult &gt;::OnServers </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01070.html">Pool</a>^&#160;</td>
<td class="paramname"><em>pl</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new <a class="el" href="a00882.html" title="This class encapsulates events that occur for cq.">Execution</a> object on all servers in the pool </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00702.html" title="Thrown when an operation unsupported by the current configuration is attempted.">UnsupportedOperationException</a></td><td>unsupported operation exception, when <a class="el" href="a01070.html" title="A pool of connections.">Pool</a> is in multiusersecure mode.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9ad1d9928df454ec7e78b198558df8c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ad1d9928df454ec7e78b198558df8c9">&#9670;&nbsp;</a></span>OnServers() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TResult &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00882.html">Execution</a>&lt;TResult&gt; ^ <a class="el" href="a00890.html">Apache::Geode::Client::FunctionService</a>&lt; TResult &gt;::OnServers </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01018.html">IRegionService</a>^&#160;</td>
<td class="paramname"><em>cache</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new <a class="el" href="a00882.html" title="This class encapsulates events that occur for cq.">Execution</a> object on all servers in the pool. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="a00638.html" title="Thrown when the state of cache is manipulated to be illegal.">IllegalStateException</a></td><td>when <a class="el" href="a01070.html" title="A pool of connections.">Pool</a> has been closed.</td></tr>
</table>
</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 .NET API Documentation</small></address>