com.hazelcast.spi.impl.operationexecutor.impl

Interface OperationQueue

All Known Implementing Classes:

OperationQueueImpl

public interface OperationQueue

The OperationQueue is the queue used to schedule operations/tasks on an OperationThread. Implementations must support Multiple-Producer Multiple-Consumers scenario as multiple GenericOperationThread share a single queue. The ScheduledQueue also support priority tasks; so if a task with a priority comes in, than that one is taken before any other normal operation is taken. The ordering between normal tasks will always be FIFO. And the same goes for the ordering between priority tasks, but there is no ordering guarantee between priority and normal tasks.

Method Summary

Modifier and Type	Method and Description
void	add(Object task, boolean priority) Adds an task to this queue.
int	normalSize() returns the number of normal operations pending.
int	prioritySize() returns the number of priority operations pending.
int	size() Returns the total number of pending operations.
Object	take(boolean priorityOnly) Takes an item from this queue.

Method Detail

add

void add(Object task,
         boolean priority)

Adds an task to this queue. This method is thread safe.

Parameters:

task - the item to add

priority - if the task has priority or not

Throws:

NullPointerException - if task is null

take

Object take(boolean priorityOnly)
     throws InterruptedException

Takes an item from this queue. If no item is available, the call blocks. This method should always be called by the same thread.

Parameters:

priorityOnly - true if only priority items should be taken. This is useful for priority generic threads since they should only take priority items.

Returns:

the taken item.

Throws:

InterruptedException - if the thread is interrupted while waiting.

normalSize

int normalSize()

returns the number of normal operations pending. This method is thread safe. This method returns a best effort value and should only be used for monitoring purposes.

Returns:

the number of normal pending operations.

prioritySize

int prioritySize()

returns the number of priority operations pending. This method is thread safe. This method returns a best effort value and should only be used for monitoring purposes.

Returns:

the number of priority pending operations.

size

int size()

Returns the total number of pending operations. This method is thread safe. This method returns a best effort value and should only be used for monitoring purposes.

Returns:

the total number of pending operations.