Class TaskQueue

A queue of async tasks.

Hierarchy

AsyncDisposableCloseable
- TaskQueue

Implements

Startable
AsyncDisposable

Index

Constructors

Properties

_pending lock paused queue queued

Accessors

pending size started

Methods

[asyncDispose] close pause poll pollLoop push runOnce runOnceThenRelease start tryPoll

Constructors

constructor

new TaskQueue(lock?, queue?, autoStart?): TaskQueue
Parameters
- lock: Lock = ...
  Lock to control task execution concurrency.
- queue: Queue<RunnableTask> = []
  Underlying task queue.
- autoStart: boolean = true
Returns TaskQueue
Overrides AsyncDisposableCloseable.constructor
- Defined in collections/src/impl/task.ts:10

Properties

`Private` _pending

_pending: number = 0

`Private` `Readonly` lock

lock: Lock = ...

Lock to control task execution concurrency.

`Private` paused

paused: boolean

`Private` `Readonly` queue

queue: Queue<RunnableTask> = []

Underlying task queue.

`Private` queued

queued: number = 0

Accessors

pending

get pending(): number
Returns the number of running but unfinished tasks.

Returns number
- Defined in collections/src/impl/task.ts:31

size

get size(): number
Returns the total number of unfinished tasks.

Returns number
- Defined in collections/src/impl/task.ts:26

started

get started(): boolean
Returns if this has started.

Returns boolean
Implementation of Startable.started
- Defined in collections/src/impl/task.ts:21

Methods

[asyncDispose]

[asyncDispose](): Promise<void>
Returns Promise<void>
Implementation of AsyncDisposable.[asyncDispose]
Inherited from AsyncDisposableCloseable.[asyncDispose]
- Defined in commons/dist/lifecycle/closeable.d.ts:15

close

close(options?): Promise<void>
Closes this object and releases any system resource associated with it.
Parameters
- Optional options: AbortOptions
Returns Promise<void>
Implementation of Startable.close
Overrides AsyncDisposableCloseable.close
- Defined in collections/src/impl/task.ts:49

pause

pause(): void
Pauses further task processing. Already started tasks will keep running.

Returns void
- Defined in collections/src/impl/task.ts:36

poll

poll(options?): Promise<void>
Polls and waits for the top queue task to complete.
Parameters
- Optional options: AbortOptions
Returns Promise<void>
- Defined in collections/src/impl/task.ts:82

`Private` pollLoop

pollLoop(): boolean
Returns boolean
- Defined in collections/src/impl/task.ts:99

push

push<T>(task, options?): Promise<T>
Adds a task to this TaskQueue.
Type Parameters
- T
Parameters
- task: Task<T>
- Optional options: TaskOptions
Returns Promise<T>
- Defined in collections/src/impl/task.ts:57

`Private` runOnce

runOnce(): Promise<void>
Returns Promise<void>
- Defined in collections/src/impl/task.ts:122

`Private` runOnceThenRelease

runOnceThenRelease(): Promise<void>
Returns Promise<void>
- Defined in collections/src/impl/task.ts:114

start

start(): void
Starts this component.

Returns void
Implementation of Startable.start
- Defined in collections/src/impl/task.ts:40

tryPoll

tryPoll(): undefined | Promise<void>
Tries to poll the top queue task and waits for it to complete if not throttled.

Returns undefined | Promise<void>
- Defined in collections/src/impl/task.ts:92

Generated using TypeDoc