Class TaskHandlerBase`Abstract`

A simple class for handling potentially repeated executions either deferred or immediate.

Hierarchy (View Summary)

default
- TaskHandlerBase
  - Task
  - TaskHandler

Implements

Cancellable

Index

Constructors

Accessors

isScheduled status

Methods

_onDispose _onExecute cancel getStatus runSynchronously start

Constructors

`Protected`constructor

new TaskHandlerBase(): TaskHandlerBase
Returns TaskHandlerBase
Overrides DisposableBase.constructor
- Defined in TaskHandlerBase.ts:19

Accessors

isScheduled

get isScheduled(): boolean
Returns boolean
- Defined in TaskHandlerBase.ts:33

status

get status(): TaskStatus
Returns TaskStatus
- Defined in TaskHandlerBase.ts:28

Methods

`Protected`_onDispose

_onDispose(): void
Returns void
Overrides DisposableBase._onDispose
- Defined in TaskHandlerBase.ts:95

`Protected` `Abstract`_onExecute

_onExecute(): void
Returns void
- Defined in TaskHandlerBase.ts:93

cancel

cancel(): boolean
Returns true if cancelled. Returns false if already run or already cancelled or unable to cancel.

Returns boolean
Implementation of Cancellable.cancel
- Defined in TaskHandlerBase.ts:75

`Protected`getStatus

getStatus(): TaskStatus
Returns TaskStatus
- Defined in TaskHandlerBase.ts:88

runSynchronously

runSynchronously(): void
Returns void
- Defined in TaskHandlerBase.ts:69

start

start(defer?: number): void
Schedules/Reschedules triggering the task.
Parameters
- defer: number = 0
  Optional time to wait until triggering.
Returns void
- Defined in TaskHandlerBase.ts:58