public class RegionSizeFunction extends java.lang.Object implements Function, Declarable
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ID |
Constructor and Description |
---|
RegionSizeFunction() |
Modifier and Type | Method and Description |
---|---|
void |
execute(FunctionContext context)
The method which contains the logic to be executed.
|
java.lang.String |
getId()
Return a unique function identifier, used to register the function
with
FunctionService |
boolean |
hasResult()
Specifies whether the function sends results while executing.
|
void |
init(java.util.Properties arg0)
Initializes a user-defined object using the given properties.
|
boolean |
isHA()
Specifies whether the function is eligible for re-execution (in case of
failure).
|
boolean |
optimizeForWrite()
Return true to indicate to GemFire the method
requires optimization for writing the targeted
FunctionService.onRegion(org.apache.geode.cache.Region) and any
associated routing objects. |
public static final java.lang.String ID
public void execute(FunctionContext context)
Function
Execution
.
The context provided to this function is the one which was built using Execution.
The contexts can be data dependent or data-independent so user should check to see if the context
provided in parameter is instance of RegionFunctionContext
.public java.lang.String getId()
Function
FunctionService
getId
in interface Function
getId
in interface Identifiable<java.lang.String>
public boolean hasResult()
Function
If Function.hasResult()
returns false,
ResultCollector.getResult()
throws FunctionException
.
If Function.hasResult()
returns true,
ResultCollector.getResult()
blocks and waits for the
result of function execution
public boolean optimizeForWrite()
Function
Return true to indicate to GemFire the method
requires optimization for writing the targeted FunctionService.onRegion(org.apache.geode.cache.Region)
and any
associated routing objects.
Returning false will optimize for read behavior on the targeted
FunctionService.onRegion(org.apache.geode.cache.Region)
and any
associated routing objects.
This method is only consulted when Region passed to FunctionService#onRegion(org.apache.geode.cache.Region) is a partitioned region
optimizeForWrite
in interface Function
FunctionService
public boolean isHA()
Function
isHA
in interface Function
FunctionContext.isPossibleDuplicate()
public void init(java.util.Properties arg0)
Declarable
Cache
initialization to fail.init
in interface Declarable
arg0
- Contains the parameters declared in the declarative xml
file.