AbstractPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=57019215eab51531af8a99c7d0f472ca09bc6c9b;hb=25926072f5397949802f6af5a2f7d49d6f15cacc;hp=24d4fdcd87839ba32767c4a376a8be492e757973;hpb=8481e318ad9225134cde44c1ccdbb2e9166aaf15;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 24d4fdcd..57019215 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,13 +1,13 @@ -AbstractPool | poolifier - v2.6.41

@@ -49,19 +49,19 @@

IPool<Worker, Data, Response>

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

Index

busy full info maxSize @@ -87,7 +88,8 @@

Methods

addWorkerNode +

addTaskFunction +addWorkerNode afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook @@ -95,19 +97,17 @@ checkAndEmitDynamicWorkerCreationEvents checkAndEmitTaskExecutionEvents checkAndEmitTaskQueuingEvents -checkDynamicPoolSize -checkFilePath checkMessageWorkerId checkNumberOfWorkers checkPoolOptions -checkValidTasksQueueOptions -checkValidWorkerChoiceStrategy checkValidWorkerChoiceStrategyOptions chooseWorkerNode createAndSetupDynamicWorkerNode createAndSetupWorkerNode createWorker +deleteTaskFunctionWorkerUsages dequeueTask +deregisterWorkerMessageListener destroy destroyWorkerNode enableTasksQueue @@ -122,29 +122,40 @@ handleTaskExecutionResponse handleWorkerReadyResponse hasBackPressure +hasTaskFunction hasWorkerNodeBackPressure +initializeEventEmitter internalBusy isMain -listTaskFunctions +listTaskFunctionNames redistributeQueuedTasks +registerOnceWorkerMessageListener registerWorkerMessageListener +removeTaskFunction removeWorkerNode sendKillMessageToWorker sendStartupMessageToWorker sendStatisticsMessageToWorker +sendTaskFunctionOperationToWorker +sendTaskFunctionOperationToWorkers sendToWorker +setDefaultTaskFunction +setTaskStealing setTasksQueueOptions setTasksQueueSize +setTasksStealingOnBackPressure setWorkerChoiceStrategy setWorkerChoiceStrategyOptions setupHook shallCreateDynamicWorker shallExecuteTask shallUpdateTaskFunctionWorkerUsage -startPool +start taskStealingOnEmptyQueue tasksQueueSize tasksStealingOnBackPressure +unsetTaskStealing +unsetTasksStealingOnBackPressure updateEluWorkerUsage updateRunTimeWorkerUsage updateTaskStatisticsWorkerUsage @@ -155,7 +166,7 @@

Constructors

constructor

new AbstractPool<Worker, Data, Response>(numberOfWorkers, filePath, opts): AbstractPool<Worker, Data, Response>
@@ -176,25 +187,29 @@
numberOfWorkers: number

Number of workers that this pool should manage.
-

filePath: string

Path to the worker file.

opts: PoolOptions<Worker>

Options for the pool.

Returns AbstractPool<Worker, Data, Response>

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

Properties

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Emitter on which events can be listened to.

`Optional` emitter

emitter?: __module | EventEmitterAsyncResource

Event emitter integrated with async resource on which events can be listened to. +The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

Events that can currently be listened to:

'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.

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

`Protected` `Readonly` filePath

filePath: string

@@ -217,7 +232,7 @@

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

`Protected` `Optional` `Readonly` max

max?: number

@@ -225,7 +240,7 @@

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

`Protected` `Readonly` numberOfWorkers

numberOfWorkers: number

@@ -233,7 +248,7 @@

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

`Protected` `Readonly` opts

opts: PoolOptions<Worker>

@@ -241,11 +256,11 @@

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

`Protected` promiseResponseMap

promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...

The task execution response promise map.

The task execution response promise map:

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

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

`Private` `Readonly` startTimestamp

startTimestamp: number

@@ -262,7 +277,7 @@

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

`Private` started

started: boolean

@@ -270,15 +285,27 @@

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

`Private` `Readonly` starting

`Private` starting

starting: boolean

Whether the pool is starting or not.

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

`Private` `Readonly` taskFunctions

taskFunctions: Map<string, TaskFunction<Data, Response>>

The task functions added at runtime map:

key: The task function name.
value: The task function itself.

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

@@ -286,7 +313,7 @@

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

`Readonly` `Internal` workerNodes

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

@@ -295,7 +322,7 @@

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

Accessors

@@ -309,7 +336,7 @@

Returns boolean

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

`Protected` full

Returns boolean

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

info

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

`Protected` maxSize

Returns number

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

`Protected` minSize

Returns number

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

`Private` ready

Returns boolean

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

`Protected` `Abstract` type

Returns "fixed" | "dynamic"

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

`Private` utilization

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

`Protected` `Abstract` worker

Returns "thread" | "cluster"

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

Methods

addTaskFunction

addTaskFunction(name, fn): Promise<boolean>
+
Adds a task function to this pool. +If a task function with the same name already exists, it will be overwritten.
+
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function.
  +
  +
- +
  fn: TaskFunction<Data, Response>
  +
  The task function.
  +
  +
+
Returns Promise<boolean>
true if the task function was added, false otherwise.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
+ +
Throws
https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.
+
+
Implementation of IPool.addTaskFunction
+
- Defined in src/pools/abstract-pool.ts:796

`Private` addWorkerNode

worker: Worker

The worker.
-

+ +

Returns number

The added worker node key.

Throws

https://nodejs.org/api/errors.html#class-error If the added worker node is not found.

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

`Protected` afterTaskExecutionHook

workerNodeKey: number

The worker node key.
-

message: MessageValue<Response, unknown>

The received message.
-

+ +

Returns void

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

`Protected` afterWorkerNodeSetup

workerNodeKey: number

The newly created worker node key.
-

+ +

Returns void

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

`Protected` beforeTaskExecutionHook

workerNodeKey: number

The worker node key.
-

task: Task<Data>

The task to execute.
-

+ +

Returns void

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

`Private` buildTasksQueueOptions

tasksQueueOptions: TasksQueueOptions

Returns TasksQueueOptions

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

`Private` checkAndEmitDynamicWorkerCreationEvents

Returns void
- Defined in src/pools/abstract-pool.ts:1403

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

`Private` checkAndEmitTaskExecutionEvents

Returns void
- Defined in src/pools/abstract-pool.ts:1391

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

`Private` checkAndEmitTaskQueuingEvents

Returns void
- Defined in src/pools/abstract-pool.ts:1397

`Protected` checkDynamicPoolSize

checkDynamicPoolSize(min, max): void
-
-
Parameters
-
- -
  min: number
- -
  max: number
-
Returns void
-
- Defined in src/pools/abstract-pool.ts:187

`Private` checkFilePath

checkFilePath(filePath): void
-
-
Parameters
-
- -
  filePath: string
-
Returns void
-
- Defined in src/pools/abstract-pool.ts:156

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

`Private` checkMessageWorkerId

Parameters

-
message: MessageValue<Response, unknown>
+
message: MessageValue<Data | Response, unknown>

The received message.
-

Returns void

Throws

https://nodejs.org/api/errors.html#class-error If the worker id is invalid.

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

`Private` checkNumberOfWorkers

numberOfWorkers: number

Returns void

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

`Private` checkPoolOptions

opts: PoolOptions<Worker>

Returns void

`Private` checkValidTasksQueueOptions

checkValidTasksQueueOptions(tasksQueueOptions): void
-
-
Parameters
-
- -
  tasksQueueOptions: TasksQueueOptions
-
Returns void
-
- Defined in src/pools/abstract-pool.ts:295

`Private` checkValidWorkerChoiceStrategy

checkValidWorkerChoiceStrategy(workerChoiceStrategy): void
-
-
Parameters
-
- -
  workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
-
Returns void
-
- Defined in src/pools/abstract-pool.ts:241

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

`Private` checkValidWorkerChoiceStrategyOptions

workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

Returns void

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

`Private` chooseWorkerNode

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

`Protected` createAndSetupDynamicWorkerNode

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

`Protected` createAndSetupWorkerNode

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

`Protected` `Abstract` createWorker

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

`Private` deleteTaskFunctionWorkerUsages

deleteTaskFunctionWorkerUsages(name): void
+
+
Parameters
+
- +
  name: string
+
Returns void
+
- Defined in src/pools/abstract-pool.ts:855

`Private` dequeueTask

workerNodeKey: number

Returns undefined | Task<Data>

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

`Protected` `Abstract` deregisterWorkerMessageListener

deregisterWorkerMessageListener<Message>(workerNodeKey, listener): 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) => void)
  +
  The message listener callback.
  +
  +
  +
  - +
    - (message): void
    - +
      +
      Parameters
      +
      +
      +
      message: MessageValue<Message, unknown>
      +
      Returns void
+
Returns void
+
+
- Defined in src/pools/abstract-pool.ts:1333

destroy

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

`Protected` `Abstract` destroyWorkerNode

workerNodeKey: number

The worker node key.
-

+ +

Returns Promise<void>

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

enableTasksQueue

enable: boolean

Whether to enable or disable the worker node tasks queue.
-

Optional tasksQueueOptions: TasksQueueOptions

The worker node tasks queue options.
-
Optional

+ +

Returns void

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

`Private` enqueueTask

task: Task<Data>

Returns number

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

execute

Optional data: Data

The optional task input data for the specified task function. This can only be structured-cloneable data.
-
Optional

Optional name: string

The optional name of the task function to execute. If not specified, the default task function will be executed.
-
Optional

Optional transferList: TransferListItem[]

An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.
-
Optional

+ +

Returns Promise<Response>

Promise that will be fulfilled when the task is completed.

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

`Private` executeTask

workerNodeKey: number

The worker node key.
-

task: Task<Data>

The task to execute.
-

+ +

Returns void

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

`Protected` flushTasksQueue

workerNodeKey: number

Returns void

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

`Private` flushTasksQueues

Returns void
- Defined in src/pools/abstract-pool.ts:1511

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

`Protected` getWorkerInfo

workerNodeKey: number

The worker node key.
-

+ +

Returns WorkerInfo

The worker information.

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

`Private` getWorkerNodeKeyByWorker

worker: Worker

The worker.
-

+ +

Returns number

The worker node key if found in the pool worker nodes, -1 otherwise.

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

`Private` getWorkerNodeKeyByWorkerId

Parameters

-
workerId: number
+
workerId: undefined | number

The worker id.
-

Returns number

The worker node key if the worker id is found in the pool worker nodes, -1 otherwise.

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

`Private` handleTaskExecutionResponse

message: MessageValue<Response, unknown>

Returns void

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

`Private` handleWorkerReadyResponse

message: MessageValue<Response, unknown>

Returns void

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

`Private` hasBackPressure

Returns boolean
- Defined in src/pools/abstract-pool.ts:1466

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

hasTaskFunction

hasTaskFunction(name): boolean
+
Whether the specified task function exists in this pool.
+
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function.
  +
  +
+
Returns boolean
true if the task function exists, false otherwise.
+ +
+
Implementation of IPool.hasTaskFunction
+
- Defined in src/pools/abstract-pool.ts:783

hasWorkerNodeBackPressure

workerNodeKey: number

The worker node key.
-

+ +

Returns boolean

true if the worker node has back pressure, false otherwise.

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

`Private` initializeEventEmitter

initializeEventEmitter(): void
+
Returns void
+
- Defined in src/pools/abstract-pool.ts:264

`Protected` internalBusy

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

`Protected` `Abstract` isMain

Returns boolean

listTaskFunctions

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

listTaskFunctionNames

listTaskFunctions(): string[]
listTaskFunctionNames(): string[]
Lists the names of task function available in this pool.

Returns string[]
The names of task function available in this pool.
-
Implementation of IPool.listTaskFunctions
+
Implementation of IPool.listTaskFunctionNames
- Defined in src/pools/abstract-pool.ts:726

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

`Private` redistributeQueuedTasks

workerNodeKey: number

Returns void

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

`Protected` `Abstract` registerOnceWorkerMessageListener

registerOnceWorkerMessageListener<Message>(workerNodeKey, listener): 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) => void)
  +
  The message listener callback.
  +
  +
  +
  - +
    - (message): void
    - +
      +
      Parameters
      +
      +
      +
      message: MessageValue<Message, unknown>
      +
      Returns void
+
Returns void
+
+
- Defined in src/pools/abstract-pool.ts:1320

`Protected` `Abstract` registerWorkerMessageListener

workerNodeKey: number

The worker node key.
-

listener: ((message) => void)

The message listener callback.

+

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

removeTaskFunction

removeTaskFunction(name): Promise<boolean>
+
Removes a task function from this pool.
+
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function.
  +
  +
+
Returns Promise<boolean>
true if the task function was removed, false otherwise.
+ +
+
Implementation of IPool.removeTaskFunction
+
- Defined in src/pools/abstract-pool.ts:819

`Private` removeWorkerNode

worker: Worker

The worker.
-

+ +

Returns void

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

`Protected` sendKillMessageToWorker

sendKillMessageToWorker(workerNodeKey, workerId): Promise<void>
sendKillMessageToWorker(workerNodeKey): Promise<void>
Parameters
- -
  workerNodeKey: number
- -
  workerId: number
+
workerNodeKey: number

Returns Promise<void>

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

`Protected` `Abstract` sendStartupMessageToWorker

workerNodeKey: number

The worker node key.
-

+ +

Returns void

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

`Private` sendStatisticsMessageToWorker

workerNodeKey: number

The worker node key.
-

+ +

Returns void

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

`Private` sendTaskFunctionOperationToWorker

sendTaskFunctionOperationToWorker(workerNodeKey, message): Promise<boolean>
+
+
Parameters
+
- +
  workerNodeKey: number
- +
  message: MessageValue<Data, unknown>
+
Returns Promise<boolean>
+
- Defined in src/pools/abstract-pool.ts:686

`Private` sendTaskFunctionOperationToWorkers

sendTaskFunctionOperationToWorkers(message): Promise<boolean>
+
+
Parameters
+
- +
  message: MessageValue<Data, unknown>
+
Returns Promise<boolean>
+
- Defined in src/pools/abstract-pool.ts:727

`Protected` `Abstract` sendToWorker

workerNodeKey: number

The worker node key.
-

message: MessageValue<Data, unknown>

The message.
-

Optional transferList: TransferListItem[]

The optional array of transferable objects.
-
Optional

+ +

Returns void

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

setDefaultTaskFunction

setDefaultTaskFunction(name): Promise<boolean>
+
Sets the default task function in this pool.
+
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function.
  +
  +
+
Returns Promise<boolean>
true if the default task function was set, false otherwise.
+ +
+
Implementation of IPool.setDefaultTaskFunction
+
- Defined in src/pools/abstract-pool.ts:848

`Private` setTaskStealing

setTaskStealing(): void
+
Returns void
+
- Defined in src/pools/abstract-pool.ts:620

setTasksQueueOptions

tasksQueueOptions: TasksQueueOptions

The worker node tasks queue options.
-

+ +

Returns void

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

`Private` setTasksQueueSize

size: number

Returns void

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

`Private` setTasksStealingOnBackPressure

setTasksStealingOnBackPressure(): void
+
Returns void
+
- Defined in src/pools/abstract-pool.ts:633

setWorkerChoiceStrategy

workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

The worker choice strategy.
-

Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

The worker choice strategy options.
-
Optional

+ +

Returns void

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

setWorkerChoiceStrategyOptions

workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

The worker choice strategy options.
-

+ +

Returns void

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

`Protected` setupHook

Returns void

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

`Private` shallCreateDynamicWorker

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

`Private` shallExecuteTask

workerNodeKey: number

Returns boolean

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

`Private` shallUpdateTaskFunctionWorkerUsage

workerNodeKey: number

The worker node key.
-

+ +

Returns boolean

true if the worker node shall update its task function worker usage, false otherwise.

`Private` startPool

startPool(): void
Defined in src/pools/abstract-pool.ts:1068

start

start(): void
-
Returns void
+
Starts the minimum number of workers in this pool.
+
+
Returns void
+
+
Implementation of IPool.start
- Defined in src/pools/abstract-pool.ts:337

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

`Private` taskStealingOnEmptyQueue

workerId: number

Returns void

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

`Private` tasksQueueSize

workerNodeKey: number

Returns number

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

`Private` tasksStealingOnBackPressure

workerId: number

Returns void

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

`Private` unsetTaskStealing

unsetTaskStealing(): void
+
Returns void
+
- Defined in src/pools/abstract-pool.ts:627

`Private` unsetTasksStealingOnBackPressure

unsetTasksStealingOnBackPressure(): void
+
Returns void
+
- Defined in src/pools/abstract-pool.ts:640

`Private` updateEluWorkerUsage

message: MessageValue<Response, unknown>

Returns void

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

`Private` updateRunTimeWorkerUsage

message: MessageValue<Response, unknown>

Returns void

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

`Private` updateTaskStatisticsWorkerUsage

message: MessageValue<Response, unknown>

Returns void

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

`Private` updateTaskStolenStatisticsWorkerUsage

taskName: string

Returns void

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

`Private` updateWaitTimeWorkerUsage

task: Task<Data>

Returns void

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

`Protected` workerListener

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

Generated using TypeDoc

\ No newline at end of file +

\ No newline at end of file

Index

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

constructor

numberOfWorkers: number

filePath: string

opts: PoolOptions<Worker>

Returns AbstractPool<Worker, Data, Response>

Properties

Optional Readonly emitter

Optional emitter

Protected Readonly filePath

Protected Optional Readonly max

Protected Readonly numberOfWorkers

Protected Readonly opts

Protected promiseResponseMap

Private Readonly startTimestamp

Private started

Private Readonly starting

Private starting

Private Readonly taskFunctions

Protected workerChoiceStrategyContext

Readonly Internal workerNodes

Accessors

Returns boolean

Protected full

Returns boolean

info

Protected maxSize

Returns number

Protected minSize

Returns number

Private ready

Returns boolean

Protected Abstract type

Returns "fixed" | "dynamic"

Private utilization

Protected Abstract worker

Returns "thread" | "cluster"

Methods

addTaskFunction

Parameters

name: string

fn: TaskFunction<Data, Response>

Returns Promise<boolean>

Throws

Throws

Private addWorkerNode

worker: Worker

Returns number

Throws

Protected afterTaskExecutionHook

workerNodeKey: number

message: MessageValue<Response, unknown>

Returns void

Protected afterWorkerNodeSetup

workerNodeKey: number

Returns void

Protected beforeTaskExecutionHook

workerNodeKey: number

task: Task<Data>

Returns void

Private buildTasksQueueOptions

tasksQueueOptions: TasksQueueOptions

Returns TasksQueueOptions

Private checkAndEmitDynamicWorkerCreationEvents

Returns void

Private checkAndEmitTaskExecutionEvents

Returns void

Private checkAndEmitTaskQueuingEvents

Returns void

Protected checkDynamicPoolSize

Parameters

min: number

max: number

`Optional` `Readonly` emitter

`Optional` emitter

`Protected` `Readonly` filePath

`Protected` `Optional` `Readonly` max

`Protected` `Readonly` numberOfWorkers

`Protected` `Readonly` opts

`Protected` promiseResponseMap

`Private` `Readonly` startTimestamp

`Private` started

`Private` `Readonly` starting

`Private` starting

`Private` `Readonly` taskFunctions

`Protected` workerChoiceStrategyContext

`Readonly` `Internal` workerNodes

`Protected` full

`Protected` maxSize

`Protected` minSize

`Private` ready

`Protected` `Abstract` type

`Private` utilization

`Protected` `Abstract` worker

`Private` addWorkerNode

`Protected` afterTaskExecutionHook

`Protected` afterWorkerNodeSetup

`Protected` beforeTaskExecutionHook

`Private` buildTasksQueueOptions

`Private` checkAndEmitDynamicWorkerCreationEvents

`Private` checkAndEmitTaskExecutionEvents

`Private` checkAndEmitTaskQueuingEvents

`Protected` checkDynamicPoolSize

`Private` checkFilePath

`Private` checkMessageWorkerId

`Private` checkNumberOfWorkers

`Private` checkPoolOptions

`Private` checkValidTasksQueueOptions

`Private` checkValidWorkerChoiceStrategy

`Private` checkValidWorkerChoiceStrategyOptions

`Private` chooseWorkerNode

`Protected` createAndSetupDynamicWorkerNode

`Protected` createAndSetupWorkerNode

`Protected` `Abstract` createWorker

`Private` deleteTaskFunctionWorkerUsages

`Private` dequeueTask

`Protected` `Abstract` deregisterWorkerMessageListener

`Protected` `Abstract` destroyWorkerNode

`Optional` tasksQueueOptions: TasksQueueOptions

`Private` enqueueTask

`Optional` data: Data

`Optional` name: string

`Optional` transferList: TransferListItem[]

`Private` executeTask

`Protected` flushTasksQueue