org.apache.geode.cache.execute

Interface FunctionContext

All Known Subinterfaces:

RegionFunctionContext

public interface FunctionContext

Defines the execution context of a Function. It is required by the Function.execute(FunctionContext) to execute a Function on a particular member.

A context can be data dependent or data independent. For data dependent functions refer to RegionFunctionContext

This interface is implemented by GemFire. Instances of it will be passed in to Function.execute(FunctionContext).

Since:

GemFire 6.0

See Also:

RegionFunctionContext

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getArguments() Returns the arguments provided to this function execution.
java.lang.String	getFunctionId() Returns the identifier of the function.
<T> ResultSender<T>	getResultSender() Returns the ResultSender which is used to add the ability for an execute method to send a single result back, or break its result into multiple pieces and send each piece back to the calling thread's ResultCollector.
boolean	isPossibleDuplicate() Returns a boolean to identify whether this is a re-execute.

Method Detail

getArguments

java.lang.Object getArguments()

Returns the arguments provided to this function execution. These are the arguments specified by the caller using Execution.withArgs(Object)

Returns:

the arguments or null if there are no arguments

Since:

GemFire 6.0

getFunctionId

java.lang.String getFunctionId()

Returns the identifier of the function.

Returns:

a unique identifier

Since:

GemFire 6.0

See Also:

Function.getId()

getResultSender

<T> ResultSender<T> getResultSender()

Returns the ResultSender which is used to add the ability for an execute method to send a single result back, or break its result into multiple pieces and send each piece back to the calling thread's ResultCollector.

Returns:

ResultSender

Since:

GemFire 6.0

isPossibleDuplicate

boolean isPossibleDuplicate()

Returns a boolean to identify whether this is a re-execute. Returns true if it is a re-execute else returns false

Returns:

a boolean (true) to identify whether it is a re-execute (else false)

Since:

GemFire 6.5

See Also:

Function.isHA()