@proto-kit/sequencer • Docs

Documentation / @proto-kit/sequencer / AbstractTaskQueue

Class: abstract AbstractTaskQueue<Config>

Lifecycle of a SequencerModule

start(): Executed to execute any logic required to start the module

Extends

• SequencerModule<Config>

Extended by

• LocalTaskQueue

Type Parameters

• Config

Constructors

new AbstractTaskQueue()

new AbstractTaskQueue<Config>(): AbstractTaskQueue<Config>

Returns

AbstractTaskQueue<Config>

Inherited from

SequencerModule.constructor

Properties

currentConfig

protected currentConfig: undefined | Config

Store the config separately, so that we can apply additional checks when retrieving it via the getter

Inherited from

SequencerModule.currentConfig

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:17

queues

protected queues: Record<string, InstantiatedQueue> = {}

Defined in

packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:8

presets

static presets: Presets<unknown> = {}

Inherited from

SequencerModule.presets

Defined in

packages/sequencer/src/sequencer/builder/SequencerModule.ts:20

Accessors

config

Get Signature

get config(): Config

Returns

Config

Set Signature

set config(config): void

Parameters

• config: Config

Returns

void

Inherited from

SequencerModule.config

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:18

Methods

closeQueues()

protected closeQueues(): Promise<void>

Returns

Promise<void>

Defined in

packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:20

create()

create(childContainerProvider): void

Parameters

• childContainerProvider: ChildContainerProvider

Returns

void

Inherited from

SequencerModule.create

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:20

createOrGetQueue()

protected createOrGetQueue(name, creator): InstantiatedQueue

Parameters

• name: string

• creator

Returns

InstantiatedQueue

Defined in

packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:10

drainAllQueues()

drainAllQueues(): Promise<void>

Returns

Promise<void>

Defined in

packages/sequencer/src/worker/queue/AbstractTaskQueue.ts:26

start()

abstract start(): Promise<void>

Start the module and all it’s functionality. The returned Promise has to resolve after initialization, since it will block in the sequencer init. That means that you mustn’t await server.start() for example.

Returns

Promise<void>

Inherited from

SequencerModule.start

Defined in

packages/sequencer/src/sequencer/builder/SequencerModule.ts:28