com.redhat.rhn.taskomatic.task.threaded

Class TaskQueue

java.lang.Object

com.redhat.rhn.taskomatic.task.threaded.TaskQueue

public class TaskQueue
extends java.lang.Object

Generic threaded queue suitable for use wherever Taskomatic tasks need to process a number of work items in parallel.

Constructor Summary

Constructors

Constructor and Description
TaskQueue()

Method Summary

Modifier and Type	Method and Description
boolean	changeRun(TaskoRun runIn) - while there're workers in the queue, they will be executed as within the same run to get stored all the logs together - otherwise we would lose the logs, because worker execution get managed automatically by the queue
int	getExecutingWorkerCount() Returns the number of currently executing workers This should never be more than the thread pool's maximum size
QueueDriver	getQueueDriver() Get the current QueueDriver
TaskoRun	getQueueRun() returns queue run
int	getQueueSize() Returns the number of workers pending
void	run() Create workers for all current candidates or set the current job run to FINISHED in case there is no new candidates and workers are all done.
void	setQueueDriver(QueueDriver driver) Store the QueueDriver instance used when run() is called
void	waitForEmptyQueue() Waits indefinitely until the queue has emptied of all workers
void	workerDone() Callback all workers should call when finished with their work item
void	workerStarting() Callback all workers should call when starting to process work

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskQueue

public TaskQueue()

Method Detail

setQueueDriver

public void setQueueDriver(QueueDriver driver)

Store the QueueDriver instance used when run() is called

Parameters:

driver - to be used as the current QueueDriver

getQueueDriver

public QueueDriver getQueueDriver()

Get the current QueueDriver

Returns:

current QueueDriver

workerStarting

public void workerStarting()

Callback all workers should call when starting to process work

workerDone

public void workerDone()

Callback all workers should call when finished with their work item

getExecutingWorkerCount

public int getExecutingWorkerCount()

Returns the number of currently executing workers This should never be more than the thread pool's maximum size

Returns:

number of currently executing workers

getQueueSize

public int getQueueSize()

Returns the number of workers pending

Returns:

number of workers pending

run

public void run()

Create workers for all current candidates or set the current job run to FINISHED in case there is no new candidates and workers are all done.

waitForEmptyQueue

public void waitForEmptyQueue()
                       throws java.lang.InterruptedException

Waits indefinitely until the queue has emptied of all workers

Throws:

java.lang.InterruptedException - the wait is interrupted

changeRun

public boolean changeRun(TaskoRun runIn)

- while there're workers in the queue, they will be executed as within the same run to get stored all the logs together - otherwise we would lose the logs, because worker execution get managed automatically by the queue

Parameters:

runIn - associated run

Returns:

whether run was changed

getQueueRun

public TaskoRun getQueueRun()

returns queue run

Returns:

queue log run