Class FixedThreadPool<Data, Response>

A thread pool with a fixed number of threads.

Author

Alessandro Pio Ardizio

Since

0.0.1

Type Parameters

Data = unknown
Type of data sent to the worker. This can only be structured-cloneable data.
Response = unknown
Type of execution response. This can only be structured-cloneable data.

Hierarchy (View Summary)

AbstractPool<Worker, Data, Response>
- FixedThreadPool
  - DynamicThreadPool

Defined in src/pools/thread/fixed.ts:25

Index

Methods

Constructors

constructor

new FixedThreadPool<Data = unknown, Response = unknown>(
numberOfThreads: number,
filePath: string,
opts?: ThreadPoolOptions,
maximumNumberOfThreads?: number,
): FixedThreadPool<Data, Response>
Constructs a new poolifier fixed thread pool.

Type Parameters
- Data = unknown
  Type of data sent to the worker. This can only be structured-cloneable data.
- Response = unknown
  Type of execution response. This can only be structured-cloneable data.
Parameters
- numberOfThreads: number
  Number of threads for this pool.
- filePath: string
  Path to an implementation of a ThreadWorker file, which can be relative or absolute.
- opts: ThreadPoolOptions = {}
  Options for this fixed thread pool.
- OptionalmaximumNumberOfThreads: number
  The maximum number of threads for this pool.
Returns FixedThreadPool<Data, Response>
Overrides AbstractPool<Worker, Data, Response>.constructor
- Defined in src/pools/thread/fixed.ts:56

Properties

`Protected`destroying

destroying: boolean

Whether the pool is destroying or not.

Inherited from AbstractPool.destroying

Defined in src/pools/abstract-pool.ts:377

`Optional`emitter

emitter?: EventEmitterAsyncResource

Inherit Doc

Inherited from AbstractPool.emitter

Defined in src/pools/abstract-pool.ts:87

`Protected` `Readonly`filePath

filePath: string

Path to the worker file.

Inherited from AbstractPool.filePath

Defined in src/pools/abstract-pool.ts:527

`Protected` `Optional` `Readonly`maximumNumberOfWorkers

maximumNumberOfWorkers?: number

Maximum number of workers that this pool manages.

Inherited from AbstractPool.maximumNumberOfWorkers

Defined in src/pools/abstract-pool.ts:529

`Protected` `Readonly`minimumNumberOfWorkers

minimumNumberOfWorkers: number

Minimum number of workers that this pool manages.

Inherited from AbstractPool.minimumNumberOfWorkers

Defined in src/pools/abstract-pool.ts:526

`Protected` `Readonly`opts

opts: PoolOptions<Worker>

Options for the pool.

Inherited from AbstractPool.opts

Defined in src/pools/abstract-pool.ts:528

`Protected`promiseResponseMap

promiseResponseMap: Map<
`${string}-${string}-${string}-${string}-${string}`,
PromiseResponseWrapper<Response>,
> = ...

The task execution response promise map:

key: The message id of each submitted task.
value: An object that contains task's worker node key, execution response promise resolve and reject callbacks, async resource.

When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.

Inherited from AbstractPool.promiseResponseMap

Defined in src/pools/abstract-pool.ts:386

`Protected`started

started: boolean

Whether the pool is started or not.

Inherited from AbstractPool.started

Defined in src/pools/abstract-pool.ts:397

`Protected`starting

starting: boolean

Whether the pool is starting or not.

Inherited from AbstractPool.starting

Defined in src/pools/abstract-pool.ts:402

`Protected` `Optional`workerChoiceStrategiesContext

workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<
Worker,
Data,
Response,
>

Worker choice strategies context referencing worker choice algorithms implementation.

Inherited from AbstractPool.workerChoiceStrategiesContext

Defined in src/pools/abstract-pool.ts:407

`Readonly`workerNodes

workerNodes: IWorkerNode<Worker, Data>[] = []

Inherit Doc

Inherited from AbstractPool.workerNodes

Defined in src/pools/abstract-pool.ts:90

Accessors

`Protected`backPressure

get backPressure(): boolean
Whether the pool is back pressured or not.

Returns boolean
The pool back pressure boolean status.

Overrides AbstractPool.backPressure
- Defined in src/pools/thread/fixed.ts:30

`Protected`busy

get busy(): boolean
Whether the pool is busy or not.

Returns boolean
The pool busyness boolean status.

Overrides AbstractPool.busy
- Defined in src/pools/thread/fixed.ts:35

info

get info(): PoolInfo
Returns PoolInfo
Inherit Doc
Inherited from AbstractPool.info
- Defined in src/pools/abstract-pool.ts:93

`Protected`type

get type(): "fixed" | "dynamic"
The pool type.

If it is 'dynamic', it provides the max property.

Returns "fixed" | "dynamic"
Overrides AbstractPool.type
- Defined in src/pools/thread/fixed.ts:40

`Protected`worker

get worker(): "cluster" | "thread"
The worker type.

Returns "cluster" | "thread"
Overrides AbstractPool.worker
- Defined in src/pools/thread/fixed.ts:45

Methods

addTaskFunction

addTaskFunction(
name: string,
fn: TaskFunction<Data, Response> | TaskFunctionObject<Data, Response>,
): Promise<boolean>
Parameters
- name: string
- fn: TaskFunction<Data, Response> | TaskFunctionObject<Data, Response>
Returns Promise<boolean>
Inherit Doc
Inherited from AbstractPool.addTaskFunction
- Defined in src/pools/abstract-pool.ts:576

`Protected`afterTaskExecutionHook

afterTaskExecutionHook(
workerNodeKey: number,
message: MessageValue<Response>,
): void
Hook executed after the worker task execution. Can be overridden.
Parameters
- workerNodeKey: number
  The worker node key.
- message: MessageValue<Response>
  The received message.
Returns void
Inherited from AbstractPool.afterTaskExecutionHook
- Defined in src/pools/abstract-pool.ts:921

`Protected`afterWorkerNodeSetup

afterWorkerNodeSetup(workerNodeKey: number): void
Method hooked up after a worker node has been newly created. Can be overridden.
Parameters
- workerNodeKey: number
  The newly created worker node key.
Returns void
Inherited from AbstractPool.afterWorkerNodeSetup
- Defined in src/pools/abstract-pool.ts:976

`Protected`beforeTaskExecutionHook

beforeTaskExecutionHook(workerNodeKey: number, task: Task<Data>): void
Hook executed before the worker task execution. Can be overridden.
Parameters
- workerNodeKey: number
  The worker node key.
- task: Task<Data>
  The task to execute.
Returns void
Inherited from AbstractPool.beforeTaskExecutionHook
- Defined in src/pools/abstract-pool.ts:1009

`Protected`checkAndEmitDynamicWorkerCreationEvents

checkAndEmitDynamicWorkerCreationEvents(): void
Emits dynamic worker creation events.

Returns void
Overrides AbstractPool.checkAndEmitDynamicWorkerCreationEvents
- Defined in src/pools/thread/fixed.ts:66

`Protected`checkAndEmitDynamicWorkerDestructionEvents

checkAndEmitDynamicWorkerDestructionEvents(): void
Emits dynamic worker destruction events.

Returns void
Overrides AbstractPool.checkAndEmitDynamicWorkerDestructionEvents
- Defined in src/pools/thread/fixed.ts:71

`Protected`createAndSetupDynamicWorkerNode

createAndSetupDynamicWorkerNode(): number
Creates a new, completely set up dynamic worker node.

Returns number
New, completely set up dynamic worker node key.

Inherited from AbstractPool.createAndSetupDynamicWorkerNode
- Defined in src/pools/abstract-pool.ts:1057

`Protected`createAndSetupWorkerNode

createAndSetupWorkerNode(): number
Creates a new, completely set up worker node.

Returns number
New, completely set up worker node key.

Inherited from AbstractPool.createAndSetupWorkerNode
- Defined in src/pools/abstract-pool.ts:1113

`Protected`deregisterWorkerMessageListener

deregisterWorkerMessageListener<Message>(
workerNodeKey: number,
listener: (message: MessageValue<Message>) => void,
): void
Deregisters a listener callback on the worker given its worker node key.

Type Parameters
- Message
Parameters
- workerNodeKey: number
  The worker node key.
- listener: (message: MessageValue<Message>) => void
  The message listener callback.
Returns void
Overrides AbstractPool.deregisterWorkerMessageListener
- Defined in src/pools/thread/fixed.ts:76

destroy

destroy(): Promise<void>
Returns Promise<void>
Inherit Doc
Inherited from AbstractPool.destroy
- Defined in src/pools/abstract-pool.ts:614

`Protected`destroyWorkerNode

destroyWorkerNode(workerNodeKey: number): Promise<void>
Terminates the worker node given its worker node key.
Parameters
- workerNodeKey: number
  The worker node key.
Returns Promise<void>
Inherited from AbstractPool.destroyWorkerNode
- Defined in src/pools/abstract-pool.ts:1182

enableTasksQueue

enableTasksQueue(enable: boolean, tasksQueueOptions?: TasksQueueOptions): void
Parameters
- enable: boolean
- OptionaltasksQueueOptions: TasksQueueOptions
Returns void
Inherit Doc
Inherited from AbstractPool.enableTasksQueue
- Defined in src/pools/abstract-pool.ts:649

execute

execute(
data?: Data,
name?: string,
abortSignal?: AbortSignal,
transferList?: readonly Transferable[],
): Promise<Response>
Parameters
- Optionaldata: Data
- Optionalname: string
- OptionalabortSignal: AbortSignal
- OptionaltransferList: readonly Transferable[]
Returns Promise<Response>
Inherit Doc
Inherited from AbstractPool.execute
- Defined in src/pools/abstract-pool.ts:663

`Protected`flagWorkerNodeAsNotReady

flagWorkerNodeAsNotReady(workerNodeKey: number): void
Parameters
- workerNodeKey: number
Returns void
Inherited from AbstractPool.flagWorkerNodeAsNotReady
- Defined in src/pools/abstract-pool.ts:1200

`Protected`flushTasksQueue

flushTasksQueue(workerNodeKey: number): number
Parameters
- workerNodeKey: number
Returns number
Inherited from AbstractPool.flushTasksQueue
- Defined in src/pools/abstract-pool.ts:1207

`Protected`getWorkerInfo

getWorkerInfo(workerNodeKey: number): WorkerInfo | undefined
Gets the worker information given its worker node key.
Parameters
- workerNodeKey: number
  The worker node key.
Returns WorkerInfo | undefined
The worker information.

Inherited from AbstractPool.getWorkerInfo
- Defined in src/pools/abstract-pool.ts:1223

hasTaskFunction

hasTaskFunction(name: string): boolean
Parameters
- name: string
Returns boolean
Inherit Doc
Inherited from AbstractPool.hasTaskFunction
- Defined in src/pools/abstract-pool.ts:691

`Protected`internalBackPressure

internalBackPressure(): boolean
Whether the worker nodes are back pressured or not.

Returns boolean
Worker nodes back pressure boolean status.

Inherited from AbstractPool.internalBackPressure
- Defined in src/pools/abstract-pool.ts:1231

`Protected`internalBusy

internalBusy(): boolean
Whether worker nodes are executing concurrently their tasks quota or not.

Returns boolean
Worker nodes busyness boolean status.

Inherited from AbstractPool.internalBusy
- Defined in src/pools/abstract-pool.ts:1248

`Protected`isMain

isMain(): boolean
Returns whether the worker is the main worker or not.

Returns boolean
true if the worker is the main worker, false otherwise.

Overrides AbstractPool.isMain
- Defined in src/pools/thread/fixed.ts:87

listTaskFunctionsProperties

listTaskFunctionsProperties(): TaskFunctionProperties[]
Returns TaskFunctionProperties[]
Inherit Doc
Inherited from AbstractPool.listTaskFunctionsProperties
- Defined in src/pools/abstract-pool.ts:698

mapExecute

mapExecute(
data: Iterable<Data>,
name?: string,
abortSignals?: Iterable<AbortSignal, any, any>,
transferList?: readonly Transferable[],
): Promise<Response[]>
Parameters
- data: Iterable<Data>
- Optionalname: string
- OptionalabortSignals: Iterable<AbortSignal, any, any>
- OptionaltransferList: readonly Transferable[]
Returns Promise<Response[]>
Inherit Doc
Inherited from AbstractPool.mapExecute
- Defined in src/pools/abstract-pool.ts:711

`Protected`registerOnceWorkerMessageListener

registerOnceWorkerMessageListener<Message>(
workerNodeKey: number,
listener: (message: MessageValue<Message>) => void,
): void
Registers once a listener callback on the worker given its worker node key.

Type Parameters
- Message
Parameters
- workerNodeKey: number
  The worker node key.
- listener: (message: MessageValue<Message>) => void
  The message listener callback.
Returns void
Overrides AbstractPool.registerOnceWorkerMessageListener
- Defined in src/pools/thread/fixed.ts:92

`Protected`registerWorkerMessageListener

registerWorkerMessageListener<Message>(
workerNodeKey: number,
listener: (message: MessageValue<Message>) => void,
): void
Registers a listener callback on the worker given its worker node key.

Type Parameters
- Message
Parameters
- workerNodeKey: number
  The worker node key.
- listener: (message: MessageValue<Message>) => void
  The message listener callback.
Returns void
Overrides AbstractPool.registerWorkerMessageListener
- Defined in src/pools/thread/fixed.ts:103

removeTaskFunction

removeTaskFunction(name: string): Promise<boolean>
Parameters
- name: string
Returns Promise<boolean>
Inherit Doc
Inherited from AbstractPool.removeTaskFunction
- Defined in src/pools/abstract-pool.ts:777

`Protected`sendStartupMessageToWorker

sendStartupMessageToWorker(workerNodeKey: number): void
Sends the startup message to worker given its worker node key.
Parameters
- workerNodeKey: number
  The worker node key.
Returns void
Overrides AbstractPool.sendStartupMessageToWorker
- Defined in src/pools/thread/fixed.ts:114

`Protected`sendToWorker

sendToWorker(
workerNodeKey: number,
message: MessageValue<Data>,
transferList?: readonly Transferable[],
): void
Sends a message to worker given its worker node key.
Parameters
- workerNodeKey: number
  The worker node key.
- message: MessageValue<Data>
  The message.
- OptionaltransferList: readonly Transferable[]
  The optional array of transferable objects.
Returns void
Overrides AbstractPool.sendToWorker
- Defined in src/pools/thread/fixed.ts:129

setDefaultTaskFunction

setDefaultTaskFunction(name: string): Promise<boolean>
Parameters
- name: string
Returns Promise<boolean>
Inherit Doc
Inherited from AbstractPool.setDefaultTaskFunction
- Defined in src/pools/abstract-pool.ts:804

setTasksQueueOptions

setTasksQueueOptions(tasksQueueOptions: TasksQueueOptions | undefined): void
Parameters
- tasksQueueOptions: TasksQueueOptions | undefined
Returns void
Inherit Doc
Inherited from AbstractPool.setTasksQueueOptions
- Defined in src/pools/abstract-pool.ts:815

`Protected`setupHook

setupHook(): void
Setup hook to execute code before worker nodes are created in the abstract constructor. Can be overridden.

Returns void
Inherited from AbstractPool.setupHook
- Defined in src/pools/abstract-pool.ts:1311

setWorkerChoiceStrategy

setWorkerChoiceStrategy(
workerChoiceStrategy:
| "FAIR_SHARE"
| "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
| "LEAST_BUSY"
| "LEAST_ELU"
| "LEAST_USED"
| "ROUND_ROBIN"
| "WEIGHTED_ROUND_ROBIN",
workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions,
): void
Parameters
- workerChoiceStrategy:
  | "FAIR_SHARE"
  | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
  | "LEAST_BUSY"
  | "LEAST_ELU"
  | "LEAST_USED"
  | "ROUND_ROBIN"
  | "WEIGHTED_ROUND_ROBIN"
- OptionalworkerChoiceStrategyOptions: WorkerChoiceStrategyOptions
Returns void
Inherit Doc
Inherited from AbstractPool.setWorkerChoiceStrategy
- Defined in src/pools/abstract-pool.ts:842

setWorkerChoiceStrategyOptions

setWorkerChoiceStrategyOptions(
workerChoiceStrategyOptions: WorkerChoiceStrategyOptions | undefined,
): boolean
Parameters
- workerChoiceStrategyOptions: WorkerChoiceStrategyOptions | undefined
Returns boolean
Inherit Doc
Inherited from AbstractPool.setWorkerChoiceStrategyOptions
- Defined in src/pools/abstract-pool.ts:873

`Protected`shallCreateDynamicWorker

shallCreateDynamicWorker(): boolean
Conditions for dynamic worker creation.

Returns boolean
Whether to create a dynamic worker or not.

Overrides AbstractPool.shallCreateDynamicWorker
- Defined in src/pools/thread/fixed.ts:144

start

start(): void
Returns void
Inherit Doc
Inherited from AbstractPool.start
- Defined in src/pools/abstract-pool.ts:898

`Protected` `Readonly`workerMessageListener

workerMessageListener(message: MessageValue<Response>): void
This method is the message listener registered on each worker.
Parameters
- message: MessageValue<Response>
  The message received from the worker.
Returns void
Inherited from AbstractPool.workerMessageListener
- Defined in src/pools/abstract-pool.ts:1325

Class FixedThreadPool<Data, Response>

Author

Since

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns FixedThreadPool<Data, Response>

Properties

Protecteddestroying

Optionalemitter

Inherit Doc

Protected ReadonlyfilePath

Protected Optional ReadonlymaximumNumberOfWorkers

Protected ReadonlyminimumNumberOfWorkers

Protected Readonlyopts

ProtectedpromiseResponseMap

Protectedstarted

Protectedstarting

Protected OptionalworkerChoiceStrategiesContext

ReadonlyworkerNodes

Inherit Doc

Accessors

ProtectedbackPressure

Returns boolean

Protectedbusy

Returns boolean

info

Returns PoolInfo

Inherit Doc

Protectedtype

Returns "fixed" | "dynamic"

Protectedworker

Returns "cluster" | "thread"

Methods

addTaskFunction

Parameters

Returns Promise<boolean>

Inherit Doc

ProtectedafterTaskExecutionHook

Parameters

Returns void

ProtectedafterWorkerNodeSetup

Parameters

Returns void

ProtectedbeforeTaskExecutionHook

Parameters

Returns void

ProtectedcheckAndEmitDynamicWorkerCreationEvents

Returns void

ProtectedcheckAndEmitDynamicWorkerDestructionEvents

Returns void

ProtectedcreateAndSetupDynamicWorkerNode

Returns number

ProtectedcreateAndSetupWorkerNode

Returns number

ProtectedderegisterWorkerMessageListener

Type Parameters

Parameters

Returns void

destroy

Returns Promise<void>

Inherit Doc

ProtecteddestroyWorkerNode

Parameters

Returns Promise<void>

enableTasksQueue

Parameters

Returns void

Inherit Doc

execute

Parameters

Returns Promise<Response>

`Protected`destroying

`Optional`emitter

`Protected` `Readonly`filePath

`Protected` `Optional` `Readonly`maximumNumberOfWorkers

`Protected` `Readonly`minimumNumberOfWorkers

`Protected` `Readonly`opts

`Protected`promiseResponseMap

`Protected`started

`Protected`starting

`Protected` `Optional`workerChoiceStrategiesContext

`Readonly`workerNodes

`Protected`backPressure

`Protected`busy

`Protected`type

`Protected`worker

`Protected`afterTaskExecutionHook

`Protected`afterWorkerNodeSetup

`Protected`beforeTaskExecutionHook

`Protected`checkAndEmitDynamicWorkerCreationEvents

`Protected`checkAndEmitDynamicWorkerDestructionEvents

`Protected`createAndSetupDynamicWorkerNode

`Protected`createAndSetupWorkerNode

`Protected`deregisterWorkerMessageListener

`Protected`destroyWorkerNode

`Protected`flagWorkerNodeAsNotReady

`Protected`flushTasksQueue

`Protected`getWorkerInfo

`Protected`internalBackPressure

`Protected`internalBusy

`Protected`isMain

`Protected`registerOnceWorkerMessageListener

`Protected`registerWorkerMessageListener

`Protected`sendStartupMessageToWorker

`Protected`sendToWorker

`Protected`setupHook

`Protected`shallCreateDynamicWorker

`Protected` `Readonly`workerMessageListener