taskshark/io.github.gearup12499.taskshark/Scheduler

Scheduler

abstract class Scheduler : SupportsAdd

An object that handles the various actions related to running Tasks.

Documentation in this class is intended for implementers (people creating custom Schedulers).

If you're just looking to use the library, check out the FastScheduler documentation.

Inheritors

Constructors

constructor()

Types

object Companion

Properties

errorOnLockDoubleAcquire

var errorOnLockDoubleAcquire: Boolean

Whether the scheduler may throw an exception for double acquires.

errorOnLockDoubleFree

var errorOnLockDoubleFree: Boolean

Whether the scheduler may throw an exception for double frees.

errorOnNeverFinalized

var errorOnNeverFinalized: Boolean

errorOnTaskDoubleFinalize

var errorOnTaskDoubleFinalize: Boolean

Whether the scheduler may throw an exception for double finalizations.

val id: Int

val tasks: <Error class: unknown class>

Functions

open override fun <T : ITask<*>> add(task: T): T

Adds an ITask to this scheduler.

fun addAll(vararg tasks: ITask<*>)

inline fun Scheduler.build(block: SequenceBuilder.() -> Unit)

open operator override fun equals(other: Any?): Boolean

getCurrentEvaluation

open fun getCurrentEvaluation(): ITask<*>?

Retrieve the current "open evaluations" - the last task to start running user code (ITask.onStart, ITask.onTick, ITask.onFinish) in this context.

abstract fun getLockOwner(lock: Lock): ITask<*>?

Returns the current owner of a Lock, or null if there is no current owner (i.e. it is released.)

getOpenEvaluations

open fun getOpenEvaluations(): List<ITask<*>>

Retrieve the list of "open evaluations" - a "mini call stack" containing the stack of tasks that are actively running user code (ITask.onStart, ITask.onTick, ITask.onFinish)

abstract fun getTickCount(): Int

open override fun hashCode(): Int

open fun refresh(task: ITask<*>)

Tries to start this Task if it is startable.

abstract fun register(task: ITask<*>): Int

Add the provided task to this Scheduler and assigns an ID. This is the second phase of registration, the first phase being ITask.register.

open fun resurvey(task: ITask<*>)

Hints to schedulers that dependencies for this task have changed.

runTaskFinalizers

abstract fun runTaskFinalizers(task: ITask<*>)

Clean up after the provided task has finished. The task should have already been moved to one of the finish states (ITask.State.Finished or ITask.State.Cancelled) before this method is called.

abstract fun tick()