org.springframework.data.gemfire.function.execution
Interface GemfireFunctionOperations

Type Parameters:
T - the preferred return type
All Known Subinterfaces:
GemfireOnRegionOperations
All Known Implementing Classes:
GemfireOnMemberFunctionTemplate, GemfireOnMembersFunctionTemplate, GemfireOnRegionFunctionTemplate, GemfireOnServerFunctionTemplate, GemfireOnServersFunctionTemplate

public interface GemfireFunctionOperations

An interface for invoking Gemfire functions


Method Summary
<T> Iterable<T>
execute(com.gemstone.gemfire.cache.execute.Function function, Object... args)
          Execute an unregistered function
<T> T
execute(GemfireFunctionCallback<T> callback)
          Execute a function using a native GemFire Execution instance
<T> Iterable<T>
execute(String functionId, Object... args)
          Execute a function registered with an ID
<T> T
executeAndExtract(com.gemstone.gemfire.cache.execute.Function function, Object... args)
          Execute an unregistered function with an expected singleton result
<T> T
executeAndExtract(String functionId, Object... args)
          Execute a function registered with an ID and with an expected singleton result
 void executeWithNoResult(String functionId, Object... args)
          Execute a function registered with an ID with no return value
 

Method Detail

execute

<T> Iterable<T> execute(com.gemstone.gemfire.cache.execute.Function function,
                        Object... args)
Execute an unregistered function

Parameters:
function - the function
args - calling arguments
Returns:
the contents of the results collector

executeAndExtract

<T> T executeAndExtract(com.gemstone.gemfire.cache.execute.Function function,
                        Object... args)
Execute an unregistered function with an expected singleton result

Parameters:
function - the function
args - calling arguments
Returns:
the first item in the results collector

execute

<T> Iterable<T> execute(String functionId,
                        Object... args)
Execute a function registered with an ID

Parameters:
functionId - the function ID
args - the calling arguments
Returns:
the results

executeWithNoResult

void executeWithNoResult(String functionId,
                         Object... args)
Execute a function registered with an ID with no return value

Parameters:
functionId - the function ID
args - the calling arguments

executeAndExtract

<T> T executeAndExtract(String functionId,
                        Object... args)
Execute a function registered with an ID and with an expected singleton result

Parameters:
functionId - the function ID
args - the calling arguments
Returns:
the first item in the results collector

execute

<T> T execute(GemfireFunctionCallback<T> callback)
Execute a function using a native GemFire Execution instance

Parameters:
callback - a callback providing the execution instance
Returns:
the execution result