| <!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: FunctionService.hpp 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="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&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 |
|  <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&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&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&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('a00143_source.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="headertitle"> |
| <div class="title">FunctionService.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="a00143.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <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> <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> <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> <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> <span class="comment"> * (the "License"); you may not use this file except in compliance with</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <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> <span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <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> <span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <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> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <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> <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> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> */</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef GEODE_FUNCTIONSERVICE_H_</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define GEODE_FUNCTIONSERVICE_H_</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="a00131.html">Execution.hpp</a>"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "internal/geode_globals.hpp"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">namespace </span>apache {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">namespace </span>geode {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">namespace </span>client {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">class </span>Pool;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">class </span>Region;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">class </span>RegionService;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">class </span>Execution;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="a00739.html"> 45</a></span> <span class="keyword">class </span>APACHE_GEODE_EXPORT <a class="code" href="a00739.html">FunctionService</a> {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">static</span> <a class="code" href="a00727.html">Execution</a> onRegion(<span class="keyword">const</span> std::shared_ptr<Region>& region);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="a00739.html#ac64664e504faa87912fc9d1d9b610054"> 80</a></span>  <span class="keyword">inline</span> <span class="keyword">static</span> <a class="code" href="a00727.html">Execution</a> <a class="code" href="a00739.html#ac64664e504faa87912fc9d1d9b610054">onServer</a>(<span class="keyword">const</span> std::shared_ptr<Pool>& pool) {</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">return</span> onServerWithPool(pool);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  }</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="a00739.html#a3862a342de28eccf58c30bb676635660"> 98</a></span>  <span class="keyword">inline</span> <span class="keyword">static</span> <a class="code" href="a00727.html">Execution</a> <a class="code" href="a00739.html#a3862a342de28eccf58c30bb676635660">onServer</a>(<a class="code" href="a00839.html">RegionService</a>& regionService) {</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordflow">return</span> onServerWithCache(regionService);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  }</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="a00739.html#a0dcd8211ec15911e26aa81b645f3e4a4"> 115</a></span>  <span class="keyword">inline</span> <span class="keyword">static</span> <a class="code" href="a00727.html">Execution</a> <a class="code" href="a00739.html#a0dcd8211ec15911e26aa81b645f3e4a4">onServers</a>(<span class="keyword">const</span> std::shared_ptr<Pool>& pool) {</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordflow">return</span> onServersWithPool(pool);</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  }</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="a00739.html#a89bf08f75d48e18c27b9d68ab9fe2a21"> 133</a></span>  <span class="keyword">inline</span> <span class="keyword">static</span> <a class="code" href="a00727.html">Execution</a> <a class="code" href="a00739.html#a89bf08f75d48e18c27b9d68ab9fe2a21">onServers</a>(<a class="code" href="a00839.html">RegionService</a>& regionService) {</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordflow">return</span> onServersWithCache(regionService);</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  }</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="keyword">virtual</span> ~<a class="code" href="a00739.html">FunctionService</a>() {}</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keyword">static</span> Execution onServerWithPool(<span class="keyword">const</span> std::shared_ptr<Pool>& pool);</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">static</span> Execution onServerWithCache(RegionService& regionService);</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keyword">static</span> Execution onServersWithPool(<span class="keyword">const</span> std::shared_ptr<Pool>& pool);</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keyword">static</span> Execution onServersWithCache(RegionService& regionService);</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> };</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> } <span class="comment">// namespace client</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> } <span class="comment">// namespace geode</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> } <span class="comment">// namespace apache</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="preprocessor">#endif // GEODE_FUNCTIONSERVICE_H_</span></div><div class="ttc" id="a00839_html"><div class="ttname"><a href="a00839.html">apache::geode::client::RegionService</a></div><div class="ttdoc">A RegionService provides access to existing regions that exist in a Geode cache.</div><div class="ttdef"><b>Definition:</b> RegionService.hpp:62</div></div> |
| <div class="ttc" id="a00739_html"><div class="ttname"><a href="a00739.html">apache::geode::client::FunctionService</a></div><div class="ttdoc">entry point for function execution</div><div class="ttdef"><b>Definition:</b> FunctionService.hpp:45</div></div> |
| <div class="ttc" id="a00727_html"><div class="ttname"><a href="a00727.html">apache::geode::client::Execution</a></div><div class="ttdoc">gathers results from function execution</div><div class="ttdef"><b>Definition:</b> Execution.hpp:47</div></div> |
| <div class="ttc" id="a00739_html_ac64664e504faa87912fc9d1d9b610054"><div class="ttname"><a href="a00739.html#ac64664e504faa87912fc9d1d9b610054">apache::geode::client::FunctionService::onServer</a></div><div class="ttdeci">static Execution onServer(const std::shared_ptr< Pool > &pool)</div><div class="ttdoc">Returns a Execution object that can be used to execute a data independent function on a server in the...</div><div class="ttdef"><b>Definition:</b> FunctionService.hpp:80</div></div> |
| <div class="ttc" id="a00739_html_a3862a342de28eccf58c30bb676635660"><div class="ttname"><a href="a00739.html#a3862a342de28eccf58c30bb676635660">apache::geode::client::FunctionService::onServer</a></div><div class="ttdeci">static Execution onServer(RegionService &regionService)</div><div class="ttdoc">Returns a Execution object that can be used to execute a data independent function on a server where ...</div><div class="ttdef"><b>Definition:</b> FunctionService.hpp:98</div></div> |
| <div class="ttc" id="a00739_html_a0dcd8211ec15911e26aa81b645f3e4a4"><div class="ttname"><a href="a00739.html#a0dcd8211ec15911e26aa81b645f3e4a4">apache::geode::client::FunctionService::onServers</a></div><div class="ttdeci">static Execution onServers(const std::shared_ptr< Pool > &pool)</div><div class="ttdoc">Returns a Execution object that can be used to execute a data independent function on all the servers...</div><div class="ttdef"><b>Definition:</b> FunctionService.hpp:115</div></div> |
| <div class="ttc" id="a00739_html_a89bf08f75d48e18c27b9d68ab9fe2a21"><div class="ttname"><a href="a00739.html#a89bf08f75d48e18c27b9d68ab9fe2a21">apache::geode::client::FunctionService::onServers</a></div><div class="ttdeci">static Execution onServers(RegionService &regionService)</div><div class="ttdoc">Returns a Execution object that can be used to execute a data independent function on all the servers...</div><div class="ttdef"><b>Definition:</b> FunctionService.hpp:133</div></div> |
| <div class="ttc" id="a00131_html"><div class="ttname"><a href="a00131.html">Execution.hpp</a></div></div> |
| </div><!-- fragment --></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> |