DynamicThreadPool | poolifier

@@ -45,21 +45,21 @@ When the maximum number of threads is reached and workers are busy, an event is

DynamicThreadPool

Defined in src/pools/thread/dynamic.ts:16

Index

Constructors

constructor +

constructor

Properties

emitter? +

emitter? filePath -max +max numberOfWorkers opts promiseResponseMap @@ -68,39 +68,55 @@ When the maximum number of threads is reached and workers are busy, an event is

Accessors

busy +

busy full info -maxSize +maxSize minSize +ready type +utilization worker

Constructors

constructor

new DynamicThreadPool<Data, Response>(min, max, filePath, opts?): DynamicThreadPool<Data, Response>
@@ -140,25 +156,29 @@ When the maximum number of threads is reached and workers are busy, an event is
Overrides FixedThreadPool.constructor
- Defined in src/pools/thread/dynamic.ts:27

Defined in src/pools/thread/dynamic.ts:28

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:

'full': Emitted when the pool is dynamic and full.
'busy': Emitted when the pool is busy.
'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.
'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
'destroy': Emitted when the pool is destroyed.
'error': Emitted when an uncaught error occurs.
'taskError': Emitted when an error occurs while executing a task.
'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).

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

`Protected` `Readonly` filePath

filePath: string

@@ -167,15 +187,16 @@ When the maximum number of threads is reached and workers are busy, an event is

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

`Protected` `Readonly` max

max: number

Maximum number of threads that can be created by this pool.

Defined in src/pools/thread/dynamic.ts:30

`Protected` `Readonly` numberOfWorkers

numberOfWorkers: number

@@ -184,7 +205,7 @@ When the maximum number of threads is reached and workers are busy, an event is

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

`Protected` `Readonly` opts

opts: ThreadPoolOptions = {}

@@ -193,11 +214,11 @@ When the maximum number of threads is reached and workers are busy, an event is

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

`Protected` promiseResponseMap

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

The execution response promise map.

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

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

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

@@ -216,16 +237,16 @@ When the maximum number of threads is reached and workers are busy, an event is

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

`Readonly` workerNodes

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

`Readonly` `Internal` workerNodes

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

Pool worker nodes.

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

Accessors

@@ -240,7 +261,7 @@ When the maximum number of threads is reached and workers are busy, an event is

Defined in src/pools/thread/dynamic.ts:44

`Protected` full

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

info

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

`Protected` maxSize

get maxSize(): number
-
Pool maximum size.
+
The pool maximum size.

Returns number
-
Overrides FixedThreadPool.maxSize
+
Inherited from FixedThreadPool.maxSize
- Defined in src/pools/thread/dynamic.ts:42

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

`Protected` minSize

get minSize(): number
-
Pool minimum size.
+
The pool minimum size.

Returns number
Inherited from FixedThreadPool.minSize
- Defined in src/pools/thread/fixed.ts:91

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

`Private` ready

get ready(): boolean
+
The pool readiness boolean status.
+
+
Returns boolean
+
+
Inherited from FixedThreadPool.ready
+
- Defined in src/pools/abstract-pool.ts:429

`Protected` type

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

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

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

Defined in src/pools/thread/dynamic.ts:39

`Private` utilization

get utilization(): number
+
The approximate pool utilization.
+
+
Returns number
The pool utilization.
+ +
+
Inherited from FixedThreadPool.utilization
+
- Defined in src/pools/abstract-pool.ts:446

`Protected` worker

get worker(): "cluster" | "thread"
get worker(): "thread" | "cluster"
-
Gets the worker type.
+
The worker type.

-
Returns "cluster" | "thread"
+
Returns "thread" | "cluster"
Inherited from FixedThreadPool.worker
- Defined in src/pools/thread/fixed.ts:86

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

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.
+
+
Inherited from FixedThreadPool.addTaskFunction
+
- Defined in src/pools/abstract-pool.ts:796

`Protected` afterTaskExecutionHook

afterTaskExecutionHook(worker, message): void
afterTaskExecutionHook(workerNodeKey, message): void
Hook executed after the worker task execution. Can be overridden.
@@ -329,8 +406,8 @@ Can be overridden.

Parameters
- -
  worker: Worker
  -
  The worker.
  +
  workerNodeKey: number
  +
  The worker node key.
- @@ -342,28 +419,28 @@ Can be overridden.
  Inherited from FixedThreadPool.afterTaskExecutionHook
  - Defined in src/pools/abstract-pool.ts:506

`Protected` afterWorkerSetup

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

`Protected` afterWorkerNodeSetup

afterWorkerSetup(worker): void
afterWorkerNodeSetup(workerNodeKey): void
-
Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +
Method hooked up after a worker node has been newly created. Can be overridden.
Parameters
- -
  worker: Worker
  -
  The newly created worker.
  +
  workerNodeKey: number
  +
  The newly created worker node key.
Returns void
-
Inherited from FixedThreadPool.afterWorkerSetup
+
Inherited from FixedThreadPool.afterWorkerNodeSetup
- Defined in src/pools/abstract-pool.ts:699

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

`Protected` beforeTaskExecutionHook

`Protected` createAndSetupDynamicWorker

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

`Protected` createAndSetupDynamicWorkerNode

createAndSetupDynamicWorker(): Worker
createAndSetupDynamicWorkerNode(): number
-
Creates a new dynamic worker and sets it up completely in the pool worker nodes.
+
Creates a new, completely set up dynamic worker node.

-
Returns Worker
New, completely set up dynamic worker.
+
Returns number
New, completely set up dynamic worker node key.
-
Inherited from FixedThreadPool.createAndSetupDynamicWorker
+
Inherited from FixedThreadPool.createAndSetupDynamicWorkerNode
- Defined in src/pools/abstract-pool.ts:742

`Protected` createAndSetupWorker

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

`Protected` createAndSetupWorkerNode

createAndSetupWorker(): Worker
createAndSetupWorkerNode(): number
-
Creates a new worker and sets it up completely in the pool worker nodes.
+
Creates a new, completely set up worker node.

-
Returns Worker
New, completely set up worker.
+
Returns number
New, completely set up worker node key.
-
Inherited from FixedThreadPool.createAndSetupWorker
+
Inherited from FixedThreadPool.createAndSetupWorkerNode
- Defined in src/pools/abstract-pool.ts:709

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

`Protected` createWorker

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

`Protected` 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
+
+
Inherited from FixedThreadPool.deregisterWorkerMessageListener
+
- Defined in src/pools/thread/fixed.ts:126

destroy

destroy(): Promise<void>
-
Terminate every current worker in this pool.
+
Terminates all workers in this pool.

Returns Promise<void>
Inherited from FixedThreadPool.destroy
- Defined in src/pools/abstract-pool.ts:451

`Protected` destroyWorker

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

`Protected` destroyWorkerNode

destroyWorker(worker): Promise<void>
destroyWorkerNode(workerNodeKey): Promise<void>
-
Terminates the given worker.
+
Terminates the worker node given its worker node key.
Parameters
- -
  worker: Worker
  -
  A worker within workerNodes.
  +
  workerNodeKey: number
  +
  The worker node key.
Returns Promise<void>
-
Inherited from FixedThreadPool.destroyWorker
+
Inherited from FixedThreadPool.destroyWorkerNode
- Defined in src/pools/thread/fixed.ts:62

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

enableTasksQueue

enableTasksQueue(enable, tasksQueueOptions?): void
-
Enables/disables the worker tasks queue in this pool.
+
Enables/disables the worker node tasks queue in this pool.
Parameters
- enable: boolean
  -
  Whether to enable or disable the worker tasks queue.
  +
  Whether to enable or disable the worker node tasks queue.
- Optional tasksQueueOptions: TasksQueueOptions
  -
  The worker tasks queue options.
  +
  The worker node tasks queue options.
Returns void
Inherited from FixedThreadPool.enableTasksQueue
- Defined in src/pools/abstract-pool.ts:357

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

execute

execute(data?, name?): Promise<Response>
execute(data?, name?, transferList?): Promise<Response>
Executes the specified function in the worker constructor with the task data input parameter.

@@ -498,12 +616,17 @@ Can be overridden.
- Optional data: Data
  -
  The task input data for the specified worker function. This can only be structured-cloneable data.
  +
  The optional task input data for the specified task function. This can only be structured-cloneable data.
- Optional name: string
  -
  The name of the worker function to execute. If not specified, the default worker function will be executed.
  +
  The optional name of the task function to execute. If not specified, the default task function will be executed.
  +
  +
- +
  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.

Returns Promise<Response>

Promise that will be fulfilled when the task is completed.

@@ -511,20 +634,97 @@ Can be overridden.

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

`Protected` flushTasksQueue

flushTasksQueue(workerNodeKey): void
+
+
Parameters
+
- +
  workerNodeKey: number
+
Returns void
+
Inherited from FixedThreadPool.flushTasksQueue
+
- Defined in src/pools/abstract-pool.ts:1669

`Protected` getWorkerInfo

getWorkerInfo(workerNodeKey): WorkerInfo
+
Gets the worker information given its worker node key.
+
+
+
Parameters
+
- +
  workerNodeKey: number
  +
  The worker node key.
  +
  +
+
Returns WorkerInfo
The worker information.
+ +
+
Inherited from FixedThreadPool.getWorkerInfo
+
- Defined in src/pools/abstract-pool.ts:1585

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.
+ +
+
Inherited from FixedThreadPool.hasTaskFunction
+
- Defined in src/pools/abstract-pool.ts:783

hasWorkerNodeBackPressure

hasWorkerNodeBackPressure(workerNodeKey): boolean
Internal +
Whether the worker node has back pressure (i.e. its tasks queue is full).
+
+
+
Parameters
+
- +
  workerNodeKey: number
  +
  The worker node key.
  +
  +
+
Returns boolean
true if the worker node has back pressure, false otherwise.
+ +
+
Inherited from FixedThreadPool.hasWorkerNodeBackPressure
+
- Defined in src/pools/abstract-pool.ts:1627

`Protected` internalBusy

internalBusy(): boolean
-
Whether worker nodes are executing at least one task.
+
Whether worker nodes are executing concurrently their tasks quota or not.

Returns boolean
Worker nodes busyness boolean status.
Inherited from FixedThreadPool.internalBusy
- Defined in src/pools/abstract-pool.ts:408

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

`Protected` isMain

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

listTaskFunctionNames

listTaskFunctionNames(): string[]
+
Lists the names of task function available in this pool.
+
+
Returns string[]
The names of task function available in this pool.
+ +
+
Inherited from FixedThreadPool.listTaskFunctionNames
+
- Defined in src/pools/abstract-pool.ts:835

`Protected` 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
+
+
Inherited from FixedThreadPool.registerOnceWorkerMessageListener
+
- Defined in src/pools/thread/fixed.ts:116

`Protected` registerWorkerMessageListener

registerWorkerMessageListener<Message>(workerNodeKey, listener): 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) => void)
  +
  The message listener callback.
  +
  +
  +
  - +
    - (message): void
    - +
      +
      Parameters
      +
      +
      +
      message: MessageValue<Message, unknown>
      +
      Returns void
+
Returns void
+
+
Inherited from FixedThreadPool.registerWorkerMessageListener
+
- Defined in src/pools/thread/fixed.ts:106

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.
+ +
+
Inherited from FixedThreadPool.removeTaskFunction
+
- Defined in src/pools/abstract-pool.ts:819

`Protected` sendKillMessageToWorker

sendKillMessageToWorker(workerNodeKey): Promise<void>
+
+
Parameters
+
- +
  workerNodeKey: number
+
Returns Promise<void>
+
Inherited from FixedThreadPool.sendKillMessageToWorker
+
- Defined in src/pools/abstract-pool.ts:953

`Protected` sendStartupMessageToWorker

sendStartupMessageToWorker(workerNodeKey): void
+
Sends the startup message to worker given its worker node key.
+
+
+
Parameters
+
- +
  workerNodeKey: number
  +
  The worker node key.
  +
  +
+
Returns void
+
+
Inherited from FixedThreadPool.sendStartupMessageToWorker
+
- Defined in src/pools/thread/fixed.ts:91

`Protected` sendToWorker

sendToWorker(worker, message): void
sendToWorker(workerNodeKey, message, transferList?): void
-
Sends a message to the given worker.
+
Sends a message to worker given its worker node key.
Parameters
- -
  worker: Worker
  -
  The worker which should receive the message.
  +
  workerNodeKey: number
  +
  The worker node key.
- message: MessageValue<Data, unknown>
  
  The message.
  
  +
- +
  Optional transferList: TransferListItem[]
  +
  The optional array of transferable objects.
  +
Returns void
Inherited from FixedThreadPool.sendToWorker
- Defined in src/pools/thread/fixed.ts:68

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

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.
+ +
+
Inherited from FixedThreadPool.setDefaultTaskFunction
+
- Defined in src/pools/abstract-pool.ts:848

setTasksQueueOptions

setTasksQueueOptions(tasksQueueOptions): void
-
Sets the worker tasks queue options in this pool.
+
Sets the worker node tasks queue options in this pool.
Parameters
- tasksQueueOptions: TasksQueueOptions
  -
  The worker tasks queue options.
  +
  The worker node tasks queue options.
Returns void
Inherited from FixedThreadPool.setTasksQueueOptions
- Defined in src/pools/abstract-pool.ts:369

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

start

start(): void
+
Starts the minimum number of workers in this pool.
+
+
Returns void
+
+
Inherited from FixedThreadPool.start
+
- Defined in src/pools/abstract-pool.ts:924

`Protected` workerListener

workerListener(): ((message) => void)
-
This function is the listener registered for each worker message.
+
This method is the listener registered for each worker message.

Returns ((message) => void)
The listener function to execute when a message is received from a worker.
@@ -654,7 +1042,7 @@ Can be overridden.
- (message): void
- -
  This function is the listener registered for each worker message.
  +
  This method is the listener registered for each worker message.
  Parameters
  @@ -667,20 +1055,20 @@ Can be overridden.
  
  Inherited from FixedThreadPool.workerListener
  
  -
  Defined in src/pools/abstract-pool.ts:769

Index

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

constructor

Properties

Optional Readonly emitter

Optional emitter

Protected Readonly filePath

Protected Readonly max

Protected Readonly numberOfWorkers

Protected Readonly opts

Protected promiseResponseMap

Protected workerChoiceStrategyContext

Readonly workerNodes

Readonly Internal workerNodes

Accessors

Protected full

info

Protected maxSize

Returns number

Protected minSize

Returns number

Private ready

Returns boolean

Protected type

Returns "fixed" | "dynamic"

Private utilization

Returns number

Protected worker

Returns "cluster" | "thread"

Returns "thread" | "cluster"

Methods

addTaskFunction

Parameters

name: string

fn: TaskFunction<Data, Response>

Returns Promise<boolean>

Throws

Throws

Protected afterTaskExecutionHook

Parameters

worker: Worker

workerNodeKey: number

Protected afterWorkerSetup

Protected afterWorkerNodeSetup

Parameters

worker: Worker

workerNodeKey: number

Returns void

Protected beforeTaskExecutionHook

Protected createAndSetupDynamicWorker

Protected createAndSetupDynamicWorkerNode

Returns Worker

Returns number

Protected createAndSetupWorker

Protected createAndSetupWorkerNode

Returns Worker

Returns number

Protected createWorker

Protected deregisterWorkerMessageListener

Type Parameters

Message

Parameters

workerNodeKey: number

listener: ((message) => void)

Parameters

message: MessageValue<Message, unknown>

Returns void

Returns void

destroy

Returns Promise<void>

Protected destroyWorker

Protected destroyWorkerNode

Parameters

worker: Worker

`Optional` `Readonly` emitter

`Optional` emitter

`Protected` `Readonly` filePath

`Protected` `Readonly` max

`Protected` `Readonly` numberOfWorkers

`Protected` `Readonly` opts

`Protected` promiseResponseMap

`Protected` workerChoiceStrategyContext

`Readonly` workerNodes

`Readonly` `Internal` workerNodes

`Protected` full

`Protected` maxSize

`Protected` minSize

`Private` ready

`Protected` type

`Private` utilization

`Protected` worker

`Protected` afterTaskExecutionHook

`Protected` afterWorkerSetup

`Protected` afterWorkerNodeSetup

`Protected` beforeTaskExecutionHook

`Protected` createAndSetupDynamicWorker

`Protected` createAndSetupDynamicWorkerNode

`Protected` createAndSetupWorker

`Protected` createAndSetupWorkerNode

`Protected` createWorker

`Protected` deregisterWorkerMessageListener

`Protected` destroyWorker

`Protected` destroyWorkerNode

`Optional` tasksQueueOptions: TasksQueueOptions

`Optional` data: Data

`Optional` name: string

`Optional` transferList: TransferListItem[]

`Protected` flushTasksQueue

`Protected` getWorkerInfo

`Protected` internalBusy

`Protected` isMain

`Protected` registerOnceWorkerMessageListener

`Protected` registerWorkerMessageListener

`Protected` sendKillMessageToWorker

`Protected` sendStartupMessageToWorker

`Protected` sendToWorker