Apache Geode Native C++ Reference  1.14.0
apache::geode::client::FunctionService Class Reference

entry point for function execution More...

Static Public Member Functions

static Execution onRegion (const std::shared_ptr< Region > &region)
 Returns a Execution object that can be used to execute a data dependent function on the specified Region. More...
 
static Execution onServer (const std::shared_ptr< Pool > &pool)
 Returns a Execution object that can be used to execute a data independent function on a server in the provided Pool. More...
 
static Execution onServer (RegionService &regionService)
 Returns a Execution object that can be used to execute a data independent function on a server where Cache is attached. More...
 
static Execution onServers (const std::shared_ptr< Pool > &pool)
 Returns a Execution object that can be used to execute a data independent function on all the servers in the provided Pool. More...
 
static Execution onServers (RegionService &regionService)
 Returns a Execution object that can be used to execute a data independent function on all the servers where Cache is attached. More...
 

Detailed Description

entry point for function execution

See also
Execution

Member Function Documentation

◆ onRegion()

static Execution apache::geode::client::FunctionService::onRegion ( const std::shared_ptr< Region > &  region)
static

Returns a Execution object that can be used to execute a data dependent function on the specified Region.


When invoked from a Geode client, the method returns an Execution instance that sends a message to one of the connected servers as specified by the Pool for the region. Depending on the filters setup on the Execution, the function is executed on all Geode members that define the data region, or a subset of members. Execution::withFilter(filter)).

Parameters
regionIf Pool is multiusersecure mode then one need to pass nstance of Region from RegionService.
Returns
Execution
Exceptions
NullPointerExceptionif the region passed in is nullptr

◆ onServer() [1/2]

static Execution apache::geode::client::FunctionService::onServer ( const std::shared_ptr< Pool > &  pool)
inlinestatic

Returns a Execution object that can be used to execute a data independent function on a server in the provided Pool.

If the server goes down while dispatching or executing the function, an Exception will be thrown.

Parameters
poolfrom which to chose a server for execution
Returns
Execution
Exceptions
NullPointerExceptionif Pool instance passed in is nullptr
UnsupportedOperationExceptionif Pool is in multiusersecure Mode

◆ onServer() [2/2]

static Execution apache::geode::client::FunctionService::onServer ( RegionService regionService)
inlinestatic

Returns a Execution object that can be used to execute a data independent function on a server where Cache is attached.

If the server goes down while dispatching or executing the function, an Exception will be thrown.

Parameters
cachecache from which to chose a server for execution
Returns
Execution
Exceptions
NullPointerExceptionif Pool instance passed in is nullptr
UnsupportedOperationExceptionif Pool is in multiusersecure Mode

◆ onServers() [1/2]

static Execution apache::geode::client::FunctionService::onServers ( const std::shared_ptr< Pool > &  pool)
inlinestatic

Returns a Execution object that can be used to execute a data independent function on all the servers in the provided Pool.

If one of the servers goes down while dispatching or executing the function on the server, an Exception will be thrown.

Parameters
poolthe set of servers to execute the function
Returns
Execution
Exceptions
NullPointerExceptionif Pool instance passed in is nullptr
UnsupportedOperationExceptionif Pool is in multiusersecure Mode

◆ onServers() [2/2]

static Execution apache::geode::client::FunctionService::onServers ( RegionService regionService)
inlinestatic

Returns a Execution object that can be used to execute a data independent function on all the servers where Cache is attached.

If one of the servers goes down while dispatching or executing the function on the server, an Exception will be thrown.

Parameters
cachethe Cache where function need to execute.
Returns
Execution
Exceptions
NullPointerExceptionif Pool instance passed in is nullptr
UnsupportedOperationExceptionif Pool is in multiusersecure Mode

Apache Geode C++ Cache API Documentation