Class TaskHandlerBase`Abstract`

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

Hierarchy

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:21

Accessors

isScheduled

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

status

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

Methods

`Protected` _onDispose

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

`Protected` `Abstract` _onExecute

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

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:77

`Protected` getStatus

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

runSynchronously

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

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:60

Generated using TypeDoc