GemFire 6.5.1.2

com.gemstone.gemfire.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

Since:
6.0
See Also:
RegionFunctionContext

Method Summary
 Serializable getArguments()
          Returns the arguments provided to this function execution.
 String getFunctionId()
          Returns the identifier of the function.
<T extends Serializable>
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

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

Returns:
the arguments or null if there are no arguments
Since:
6.0

getFunctionId

String getFunctionId()
Returns the identifier of the function.

Returns:
a unique identifier
Since:
6.0
See Also:
Function.getId()

getResultSender

<T extends Serializable> 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:
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:
6.5
See Also:
Function.isHA()

GemFire 6.5.1.2

Copyright © 2002-2010 GemStone Systems, Inc. All Rights Reserved.