agi.foundation.infrastructure.threading

(agi.foundation.core-2024r3.jar)

Class RecurringTaskScheduler

java.lang.Object

agi.foundation.infrastructure.threading.RecurringTaskScheduler

All Implemented Interfaces:

IDisposable, AutoCloseable

public class RecurringTaskScheduler
extends Object
implements IDisposable

A scheduler for recurring tasks that attempts to run all of its tasks in a fair manner. The number of threads to be used to run tasks can be specified. While every effort is made to ensure that tasks are run at their desired period, the accuracy of the scheduler is system dependent.

Constructor Summary

Constructors

Constructor and Description
RecurringTaskScheduler() Initializes a new instance.
RecurringTaskScheduler(int numberOfThreads) Initializes a new instance to use a specified number of threads.

Method Summary

Modifier and Type	Method and Description
void	addTask(Duration period, RecurringTask task) Adds a task to be executed on a recurring basis.
void	dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
boolean	getIsRunning() Gets a value indicating if the scheduler in running.
int	getNumberOfThreads() Gets the number of threads used to execute the recurring tasks.
int	getTaskCount() Gets the number of tasks.
RecurringTaskStatistics	getTaskData(RecurringTask task) Gets a copy of the performance metrics associated with the given recurring task.
Iterable<RecurringTask>	getTasks() Gets the list of tasks.
RecurringTaskStatistics	removeTask(RecurringTask task) Removes a task so that it is no longer executed on a recurring basis.
void	start() Starts running the scheduler.
void	stop() Stops running the scheduler.

Methods inherited from class java.lang.Object

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

Methods inherited from interface agi.foundation.compatibility.IDisposable

close

Constructor Detail

RecurringTaskScheduler

public RecurringTaskScheduler()

Initializes a new instance. The scheduler uses the number of threads indicated by the ThreadingPolicy.

RecurringTaskScheduler

public RecurringTaskScheduler(int numberOfThreads)

Initializes a new instance to use a specified number of threads.

Parameters:

numberOfThreads - The number of threads to use to run tasks.

Throws:

ArgumentOutOfRangeException - Thrown if the value of numberOfThreads is less than 1.

Method Detail

start

public final void start()

Starts running the scheduler. This method returns once NumberOfThreads (get) threads have been started.

Throws:

IllegalStateException - Thrown if the scheduler is already running.

getIsRunning

public final boolean getIsRunning()

Gets a value indicating if the scheduler in running.

stop

public final void stop()

Stops running the scheduler. This method does not return until all threads have stopped.

Throws:

InterruptedException

IllegalStateException - Thrown if the scheduler is not running.

dispose

public void dispose()

Description copied from interface: IDisposable

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Specified by:

dispose in interface IDisposable

getNumberOfThreads

public final int getNumberOfThreads()

Gets the number of threads used to execute the recurring tasks.

addTask

public final void addTask(Duration period,
                          RecurringTask task)

Adds a task to be executed on a recurring basis.

Parameters:

period - The period at which to execute the task.

task - The task to add.

Throws:

ArgumentNullException - Thrown if task is null.

removeTask

public final RecurringTaskStatistics removeTask(RecurringTask task)

Removes a task so that it is no longer executed on a recurring basis.

Parameters:

task - The task to remove.

Throws:

ArgumentNullException - Thrown if task is null.

ArgumentException - Thrown if task was never added to the scheduler.

getTaskCount

public final int getTaskCount()

Gets the number of tasks.

getTasks

public final Iterable<RecurringTask> getTasks()

Gets the list of tasks.

getTaskData

public final RecurringTaskStatistics getTaskData(RecurringTask task)

Gets a copy of the performance metrics associated with the given recurring task.

Throws:

ArgumentNullException - Thrown if task is null.

ArgumentException - Thrown if task was never added to the scheduler.