net.lecousin.framework.concurrent

Interface TaskPriorityManager

All Known Implementing Classes:

StandaloneTaskPriorityManager

public interface TaskPriorityManager

Interface to implement to manage the priority of tasks. Task workers (threads) will come to peek the next task to execute.

Method Summary

Modifier and Type	Method and Description
void	add(Task<?,?> task) Add a task to execute.
void	forceStop() always called inside a synchronized block on this instance.
int	getRemainingTasks(boolean includingBackground) Return the number of waiting tasks.
boolean	hasRemainingTasks(boolean includingBackground) Return true if at least one task is waiting to execute.
Task<?,?>	peekNext() Return a task if one is immediately available, or null.
Task<?,?>	peekNextOrWait() Return a task if one is immediately available, or pause the calling thread.
boolean	remove(Task<?,?> task) Remove a task.
List<Task<?,?>>	removeAllPendingTasks() always called inside a synchronized block on this instance.
void	setTaskManager(TaskManager taskManager) Set the associated TaskManager that will execute tasks.

Method Detail

setTaskManager

void setTaskManager(TaskManager taskManager)

Set the associated TaskManager that will execute tasks.

add

void add(Task<?,?> task)

Add a task to execute.

remove

boolean remove(Task<?,?> task)

Remove a task.

peekNextOrWait

Task<?,?> peekNextOrWait()

Return a task if one is immediately available, or pause the calling thread. If the thread is paused, null is returned when resumed in order to give a chance to check if there is something more urgent than peeking a new task. This method is always called inside a synchronized block on this instance.

peekNext

Task<?,?> peekNext()

Return a task if one is immediately available, or null. This method is always called inside a synchronized block on this instance.

getRemainingTasks

int getRemainingTasks(boolean includingBackground)

Return the number of waiting tasks.

hasRemainingTasks

boolean hasRemainingTasks(boolean includingBackground)

Return true if at least one task is waiting to execute.

removeAllPendingTasks

List<Task<?,?>> removeAllPendingTasks()

always called inside a synchronized block on this instance.

forceStop

void forceStop()

always called inside a synchronized block on this instance.