agi.foundation.infrastructure.threading

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

Class RecurringTaskStatistics

java.lang.Object

agi.foundation.infrastructure.threading.RecurringTaskStatistics

public class RecurringTaskStatistics
extends Object

Contains information about the performance of a RecurringTask being managed by a RecurringTaskScheduler.

Method Summary

Modifier and Type	Method and Description
Duration	getAverageExecutionTime() Gets the average execution time of the task.
boolean	getIsExecuting() Gets a value indicating whether the task is currently executing.
long	getLastFinish() Gets the number of ticks in the Stopwatch timer mechanism at the time the task last finished execution.
long	getNextStart() Gets the number of ticks in the Stopwatch timer mechanism at the time the task will next be excecuted.
Duration	getPeriod() Gets the period at which the task is executed.
RecurringTask	getTask() Gets the recurring task.
long	getTimesExecuted() Gets the number of times the task has been executed.
long	getTotalTicks() Gets the total number of ticks in the Stopwatch timer mechanism that have elapsed while this task was executing.

Methods inherited from class java.lang.Object

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

Method Detail

getTask

public final RecurringTask getTask()

Gets the recurring task.

getPeriod

public final Duration getPeriod()

Gets the period at which the task is executed.

getIsExecuting

public final boolean getIsExecuting()

Gets a value indicating whether the task is currently executing.

getLastFinish

public final long getLastFinish()

Gets the number of ticks in the Stopwatch timer mechanism at the time the task last finished execution.

getNextStart

public final long getNextStart()

Gets the number of ticks in the Stopwatch timer mechanism at the time the task will next be excecuted.

getTotalTicks

public final long getTotalTicks()

Gets the total number of ticks in the Stopwatch timer mechanism that have elapsed while this task was executing.

getTimesExecuted

public final long getTimesExecuted()

Gets the number of times the task has been executed.

getAverageExecutionTime

public final Duration getAverageExecutionTime()

Gets the average execution time of the task.