Interface GemfireFunctionOperations
- All Known Subinterfaces:
GemfireOnRegionOperations
- All Known Implementing Classes:
AbstractClientFunctionTemplate
,GemfireOnMemberFunctionTemplate
,GemfireOnMembersFunctionTemplate
,GemfireOnRegionFunctionTemplate
,GemfireOnServerFunctionTemplate
,GemfireOnServersFunctionTemplate
public interface GemfireFunctionOperations
An interface for invoking Gemfire functions
- Author:
- David Turanski
-
Method Summary
Modifier and TypeMethodDescription<T> Iterable<T>
Execute a GemFire Function registered with the given ID.<T> Iterable<T>
Execute an unregistered GemFire Function with the given arguments.<T> T
execute
(GemfireFunctionCallback<T> callback) Execute a GemFire Function using a native GemFireExecution
instance.<T> T
executeAndExtract
(String functionId, Object... args) Execute a GemFire Function registered with an ID and with an expected singleton result<T> T
executeAndExtract
(Function function, Object... args) Execute an unregistered GemFire Function with the expected singleton result.void
executeWithNoResult
(String functionId, Object... args) Execute a GemFire Function registered with the given ID having no return value.
-
Method Details
-
execute
Execute an unregistered GemFire Function with the given arguments.- Type Parameters:
T
- type parameter specifying the result type of the Function execution.- Parameters:
function
- the GemFire Function object to execute.args
- an array of Object arguments to the Function call.- Returns:
- the contents of the ResultsCollector.
-
execute
Execute a GemFire Function registered with the given ID.- Type Parameters:
T
- type parameter specifying the result type of the Function execution.- Parameters:
functionId
- the ID under which the GemFire function is registered.args
- an array of Object arguments to the Function call.- Returns:
- the results
-
executeAndExtract
Execute an unregistered GemFire Function with the expected singleton result.- Type Parameters:
T
- type parameter specifying the result type of the Function execution.- Parameters:
function
- the GemFire Function object.args
- an array of Object arguments to the Function call.- Returns:
- the first item in the ResultsCollector.
- See Also:
-
executeAndExtract
Execute a GemFire Function registered with an ID and with an expected singleton result- Type Parameters:
T
- type parameter specifying the result type of the Function execution.- Parameters:
functionId
- the ID under which the GemFire function is registered.args
- an array of Object arguments to the Function call.- Returns:
- the first item in the results collector
-
executeWithNoResult
Execute a GemFire Function registered with the given ID having no return value.- Parameters:
functionId
- the ID under which the GemFire function is registered.args
- an array of Object arguments to the Function call.
-
execute
Execute a GemFire Function using a native GemFireExecution
instance.- Type Parameters:
T
- type parameter specifying the result type of the Function execution.- Parameters:
callback
- a callback providing the execution instance.- Returns:
- the Function execution result.
- See Also:
-