com.hazelcast.spi.impl.operationexecutor

Interface OperationExecutor

All Superinterfaces:

Consumer<Packet>, LiveOperationsTracker

All Known Implementing Classes:

OperationExecutorImpl

public interface OperationExecutor
extends Consumer<Packet>, LiveOperationsTracker

The OperationExecutor is responsible for scheduling work (packets/operations) to be executed. It can be compared to a Executor with the big difference that it is designed for assigning packets, operations and PartitionSpecificRunnable to a thread instead of only runnables. It depends on the implementation if an operation is executed on the calling thread or not. For example the OperationExecutorImpl will always offload a partition specific Operation to the correct partition-operation-thread. The actual processing of a operation-packet, Operation, or a PartitionSpecificRunnable is forwarded to the OperationRunner.

Method Summary

Modifier and Type	Method and Description
void	execute(Operation op) Executes the given Operation at some point in the future.
void	execute(PartitionSpecificRunnable task) Executes the given PartitionSpecificRunnable at some point in the future.
void	executeOnPartitions(PartitionTaskFactory taskFactory, BitSet partitions) Executes a task from the taskFactory for each of the given partitions.
void	executeOnPartitionThreads(Runnable task) Executes the task on every partition thread.
long	getExecutedOperationCount() Returns the number of executed operations.
OperationRunner[]	getGenericOperationRunners() Gets all the generic operation handlers.
int	getGenericThreadCount() Returns the number of generic threads.
OperationRunner[]	getPartitionOperationRunners() Gets all the operation handlers for the partitions.
int	getPartitionThreadCount() Returns the number of partition threads.
int	getPartitionThreadId(int partitionId) Returns the ID of the partitionThread assigned to handle partition with given partitionId
int	getPriorityQueueSize() Deprecated.
int	getQueueSize() Deprecated.
int	getRunningOperationCount() Deprecated.
boolean	isInvocationAllowed(Operation op, boolean isAsync) Checks if the Operation is allowed to be invoked from the current thread.
boolean	isRunAllowed(Operation op) Checks if the Operation is allowed to run on the current thread.
void	run(Operation op) Runs the Operation on the calling thread.
void	runOrExecute(Operation op) Tries to run the Operation on the calling thread if allowed.
void	shutdown() Shuts down this OperationExecutor.
void	start() Starts this OperationExecutor.

Methods inherited from interface com.hazelcast.util.function.Consumer

accept

Methods inherited from interface com.hazelcast.spi.LiveOperationsTracker

populate

Method Detail

getRunningOperationCount

@Deprecated
int getRunningOperationCount()

Deprecated.

getQueueSize

@Deprecated
int getQueueSize()

Deprecated.

getPriorityQueueSize

@Deprecated
int getPriorityQueueSize()

Deprecated.

getExecutedOperationCount

long getExecutedOperationCount()

Returns the number of executed operations.

getPartitionThreadCount

int getPartitionThreadCount()

Returns the number of partition threads.

Returns:

number of partition threads.

getGenericThreadCount

int getGenericThreadCount()

Returns the number of generic threads.

Returns:

number of generic threads.

getPartitionOperationRunners

OperationRunner[] getPartitionOperationRunners()

Gets all the operation handlers for the partitions. Each partition will have its own operation handler. So if there are 271 partitions, then the size of the array will be 271.

Don't modify the content of the array!

Returns:

the operation handlers.

getGenericOperationRunners

OperationRunner[] getGenericOperationRunners()

Gets all the generic operation handlers. The number of generic operation handlers depends on the number of generic threads.

Don't modify the content of the array!

Returns:

the generic operation handlers.

execute

void execute(Operation op)

Executes the given Operation at some point in the future.

Parameters:

op - the operation to execute.

Throws:

NullPointerException - if op is null.

executeOnPartitions

void executeOnPartitions(PartitionTaskFactory taskFactory,
                         BitSet partitions)

Executes a task from the taskFactory for each of the given partitions. The reason this method exists is to prevent a bubble of operations/tasks to be created on the work-queue if the regular execute(Operation) would be called in a loop. The consequence of this bubble is that no other operations can interleave and this can lead to very bad latency for the other operations. This method can be used to create Operations and Runnable's to be executed on a partition thread. No check is done if the partition is actually local or not!

Parameters:

taskFactory - the PartitionTaskFactory responsible for creating tasks.

partitions - the partitions to execute tasks on. This BitSet should not modified after this method is called. For each of the partitions there is a bit indicating if a task should be executed on the partition.

execute

void execute(PartitionSpecificRunnable task)

Executes the given PartitionSpecificRunnable at some point in the future.

Parameters:

task - the task the execute.

Throws:

NullPointerException - if task is null.

executeOnPartitionThreads

void executeOnPartitionThreads(Runnable task)

Executes the task on every partition thread.

Parameters:

task - the task the execute.

Throws:

NullPointerException - if task is null.

run

void run(Operation op)

Runs the Operation on the calling thread.

Parameters:

op - the Operation to run.

Throws:

NullPointerException - if op is null.

IllegalThreadStateException - if the operation is not allowed to be run on the calling thread.

runOrExecute

void runOrExecute(Operation op)

Tries to run the Operation on the calling thread if allowed. Otherwise the operation is submitted for executing using execute(Operation).

Parameters:

op - the Operation to run or execute.

Throws:

NullPointerException - if op is null.

isRunAllowed

boolean isRunAllowed(Operation op)

Checks if the Operation is allowed to run on the current thread.

Parameters:

op - the Operation to check

Returns:

true if it is allowed, false otherwise.

Throws:

NullPointerException - if op is null.

isInvocationAllowed

boolean isInvocationAllowed(Operation op,
                            boolean isAsync)

Checks if the Operation is allowed to be invoked from the current thread. Invoking means that the operation can be executed on another thread, but that one is going to block for completion using the future.get/join etc. Blocking for completion can cause problems, e.g. when you hog a partition thread or deadlocks.

Parameters:

op - the Operation to check

isAsync - is the invocation async, if false invocation does not return a future to block on

Returns:

true if allowed, false otherwise.

getPartitionThreadId

int getPartitionThreadId(int partitionId)

Returns the ID of the partitionThread assigned to handle partition with given partitionId

Parameters:

partitionId - given partitionId

Returns:

ID of the partitionThread assigned to handle partition with given partitionId

start

void start()

Starts this OperationExecutor.

shutdown

void shutdown()

Shuts down this OperationExecutor. Any pending tasks are discarded.