| <!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: apache::geode::client::FunctionService Class 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&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.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&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('a00739.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 Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>entry point for function execution |
| <a href="a00739.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:a824e55ef433d8c7d9cf5a7910422899c"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00727.html">Execution</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00739.html#a824e55ef433d8c7d9cf5a7910422899c">onRegion</a> (const std::shared_ptr< <a class="el" href="a00815.html">Region</a> > &region)</td></tr> |
| <tr class="memdesc:a824e55ef433d8c7d9cf5a7910422899c"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="a00727.html">Execution</a> object that can be used to execute a data dependent function on the specified <a class="el" href="a00815.html" title="This class manages subregions and cached data.">Region</a>. <a href="#a824e55ef433d8c7d9cf5a7910422899c">More...</a><br /></td></tr> |
| <tr class="separator:a824e55ef433d8c7d9cf5a7910422899c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac64664e504faa87912fc9d1d9b610054"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00727.html">Execution</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00739.html#ac64664e504faa87912fc9d1d9b610054">onServer</a> (const std::shared_ptr< <a class="el" href="a00787.html">Pool</a> > &pool)</td></tr> |
| <tr class="memdesc:ac64664e504faa87912fc9d1d9b610054"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="a00727.html">Execution</a> object that can be used to execute a data independent function on a server in the provided <a class="el" href="a00787.html">Pool</a>. <a href="#ac64664e504faa87912fc9d1d9b610054">More...</a><br /></td></tr> |
| <tr class="separator:ac64664e504faa87912fc9d1d9b610054"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3862a342de28eccf58c30bb676635660"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00727.html">Execution</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00739.html#a3862a342de28eccf58c30bb676635660">onServer</a> (<a class="el" href="a00839.html">RegionService</a> &regionService)</td></tr> |
| <tr class="memdesc:a3862a342de28eccf58c30bb676635660"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="a00727.html">Execution</a> object that can be used to execute a data independent function on a server where <a class="el" href="a00287.html" title="Caches are obtained from the create method on the CacheFactory#create class.">Cache</a> is attached. <a href="#a3862a342de28eccf58c30bb676635660">More...</a><br /></td></tr> |
| <tr class="separator:a3862a342de28eccf58c30bb676635660"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0dcd8211ec15911e26aa81b645f3e4a4"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00727.html">Execution</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00739.html#a0dcd8211ec15911e26aa81b645f3e4a4">onServers</a> (const std::shared_ptr< <a class="el" href="a00787.html">Pool</a> > &pool)</td></tr> |
| <tr class="memdesc:a0dcd8211ec15911e26aa81b645f3e4a4"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="a00727.html">Execution</a> object that can be used to execute a data independent function on all the servers in the provided <a class="el" href="a00787.html">Pool</a>. <a href="#a0dcd8211ec15911e26aa81b645f3e4a4">More...</a><br /></td></tr> |
| <tr class="separator:a0dcd8211ec15911e26aa81b645f3e4a4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a89bf08f75d48e18c27b9d68ab9fe2a21"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00727.html">Execution</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00739.html#a89bf08f75d48e18c27b9d68ab9fe2a21">onServers</a> (<a class="el" href="a00839.html">RegionService</a> &regionService)</td></tr> |
| <tr class="memdesc:a89bf08f75d48e18c27b9d68ab9fe2a21"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="a00727.html">Execution</a> object that can be used to execute a data independent function on all the servers where <a class="el" href="a00287.html" title="Caches are obtained from the create method on the CacheFactory#create class.">Cache</a> is attached. <a href="#a89bf08f75d48e18c27b9d68ab9fe2a21">More...</a><br /></td></tr> |
| <tr class="separator:a89bf08f75d48e18c27b9d68ab9fe2a21"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>entry point for function execution </p> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="a00727.html" title="gathers results from function execution">Execution</a> </dd></dl> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a824e55ef433d8c7d9cf5a7910422899c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a824e55ef433d8c7d9cf5a7910422899c">◆ </a></span>onRegion()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="a00727.html">Execution</a> apache::geode::client::FunctionService::onRegion </td> |
| <td>(</td> |
| <td class="paramtype">const std::shared_ptr< <a class="el" href="a00815.html">Region</a> > & </td> |
| <td class="paramname"><em>region</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>Returns a <a class="el" href="a00727.html">Execution</a> object that can be used to execute a data dependent function on the specified <a class="el" href="a00815.html" title="This class manages subregions and cached data.">Region</a>. </p> |
| <p><br /> |
| When invoked from a Geode client, the method returns an <a class="el" href="a00727.html" title="gathers results from function execution">Execution</a> instance that sends a message to one of the connected servers as specified by the <a class="el" href="a00787.html">Pool</a> for the region. Depending on the filters setup on the <a class="el" href="a00727.html">Execution</a>, the function is executed on all Geode members that define the data region, or a subset of members. <a class="el" href="">Execution::withFilter(filter)</a>).</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">region</td><td>If <a class="el" href="a00787.html" title="A pool of connections to connect from a client to a set of Geode Cache Servers.">Pool</a> is multiusersecure mode then one need to pass nstance of <a class="el" href="a00815.html" title="This class manages subregions and cached data.">Region</a> from <a class="el" href="a00839.html" title="A RegionService provides access to existing regions that exist in a Geode cache.">RegionService</a>.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="a00727.html" title="gathers results from function execution">Execution</a> </dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00567.html" title="Thrown when a null argument is provided to a method where it is expected to be non-null.">NullPointerException</a></td><td>if the region passed in is nullptr </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ac64664e504faa87912fc9d1d9b610054"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac64664e504faa87912fc9d1d9b610054">◆ </a></span>onServer() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="a00727.html">Execution</a> apache::geode::client::FunctionService::onServer </td> |
| <td>(</td> |
| <td class="paramtype">const std::shared_ptr< <a class="el" href="a00787.html">Pool</a> > & </td> |
| <td class="paramname"><em>pool</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a <a class="el" href="a00727.html">Execution</a> object that can be used to execute a data independent function on a server in the provided <a class="el" href="a00787.html">Pool</a>. </p> |
| <p>If the server goes down while dispatching or executing the function, an <a class="el" href="a00463.html" title="A description of an exception that occurred during a cache operation.">Exception</a> will be thrown. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">pool</td><td>from which to chose a server for execution </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="a00727.html" title="gathers results from function execution">Execution</a> </dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00567.html" title="Thrown when a null argument is provided to a method where it is expected to be non-null.">NullPointerException</a></td><td>if <a class="el" href="a00787.html" title="A pool of connections to connect from a client to a set of Geode Cache Servers.">Pool</a> instance passed in is nullptr </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00535.html" title="Thrown when an operation unsupported by the current configuration is attempted.">UnsupportedOperationException</a></td><td>if <a class="el" href="a00787.html" title="A pool of connections to connect from a client to a set of Geode Cache Servers.">Pool</a> is in multiusersecure Mode </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a3862a342de28eccf58c30bb676635660"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3862a342de28eccf58c30bb676635660">◆ </a></span>onServer() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="a00727.html">Execution</a> apache::geode::client::FunctionService::onServer </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a00839.html">RegionService</a> & </td> |
| <td class="paramname"><em>regionService</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a <a class="el" href="a00727.html">Execution</a> object that can be used to execute a data independent function on a server where <a class="el" href="a00287.html" title="Caches are obtained from the create method on the CacheFactory#create class.">Cache</a> is attached. </p> |
| <p>If the server goes down while dispatching or executing the function, an <a class="el" href="a00463.html" title="A description of an exception that occurred during a cache operation.">Exception</a> will be thrown. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">cache</td><td>cache from which to chose a server for execution </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="a00727.html" title="gathers results from function execution">Execution</a> </dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00567.html" title="Thrown when a null argument is provided to a method where it is expected to be non-null.">NullPointerException</a></td><td>if <a class="el" href="a00787.html" title="A pool of connections to connect from a client to a set of Geode Cache Servers.">Pool</a> instance passed in is nullptr </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00535.html" title="Thrown when an operation unsupported by the current configuration is attempted.">UnsupportedOperationException</a></td><td>if <a class="el" href="a00787.html" title="A pool of connections to connect from a client to a set of Geode Cache Servers.">Pool</a> is in multiusersecure Mode </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a0dcd8211ec15911e26aa81b645f3e4a4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0dcd8211ec15911e26aa81b645f3e4a4">◆ </a></span>onServers() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="a00727.html">Execution</a> apache::geode::client::FunctionService::onServers </td> |
| <td>(</td> |
| <td class="paramtype">const std::shared_ptr< <a class="el" href="a00787.html">Pool</a> > & </td> |
| <td class="paramname"><em>pool</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a <a class="el" href="a00727.html">Execution</a> object that can be used to execute a data independent function on all the servers in the provided <a class="el" href="a00787.html">Pool</a>. </p> |
| <p>If one of the servers goes down while dispatching or executing the function on the server, an <a class="el" href="a00463.html" title="A description of an exception that occurred during a cache operation.">Exception</a> will be thrown.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">pool</td><td>the set of servers to execute the function </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="a00727.html" title="gathers results from function execution">Execution</a> </dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00567.html" title="Thrown when a null argument is provided to a method where it is expected to be non-null.">NullPointerException</a></td><td>if <a class="el" href="a00787.html" title="A pool of connections to connect from a client to a set of Geode Cache Servers.">Pool</a> instance passed in is nullptr </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00535.html" title="Thrown when an operation unsupported by the current configuration is attempted.">UnsupportedOperationException</a></td><td>if <a class="el" href="a00787.html" title="A pool of connections to connect from a client to a set of Geode Cache Servers.">Pool</a> is in multiusersecure Mode </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a89bf08f75d48e18c27b9d68ab9fe2a21"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a89bf08f75d48e18c27b9d68ab9fe2a21">◆ </a></span>onServers() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="a00727.html">Execution</a> apache::geode::client::FunctionService::onServers </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a00839.html">RegionService</a> & </td> |
| <td class="paramname"><em>regionService</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns a <a class="el" href="a00727.html">Execution</a> object that can be used to execute a data independent function on all the servers where <a class="el" href="a00287.html" title="Caches are obtained from the create method on the CacheFactory#create class.">Cache</a> is attached. </p> |
| <p>If one of the servers goes down while dispatching or executing the function on the server, an <a class="el" href="a00463.html" title="A description of an exception that occurred during a cache operation.">Exception</a> will be thrown.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">cache</td><td>the <a class="el" href="a00287.html">Cache</a> where function need to execute. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="a00727.html" title="gathers results from function execution">Execution</a> </dd></dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00567.html" title="Thrown when a null argument is provided to a method where it is expected to be non-null.">NullPointerException</a></td><td>if <a class="el" href="a00787.html" title="A pool of connections to connect from a client to a set of Geode Cache Servers.">Pool</a> instance passed in is nullptr </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00535.html" title="Thrown when an operation unsupported by the current configuration is attempted.">UnsupportedOperationException</a></td><td>if <a class="el" href="a00787.html" title="A pool of connections to connect from a client to a set of Geode Cache Servers.">Pool</a> is in multiusersecure Mode </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 API Documentation</small></address> |
