DynamicClusterPool | poolifier

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

DynamicClusterPool

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

Index

Constructors

constructor +

constructor

Properties

emitter? +

emitter? filePath max numberOfWorkers @@ -68,7 +68,7 @@ When the maximum number of workers is reached and workers are busy, an event is

Accessors

busy +

busy full info maxSize @@ -80,37 +80,44 @@ When the maximum number of workers is reached and workers are busy, an event is

Constructors

constructor

new DynamicClusterPool<Data, Response>(min, max, filePath, opts?): DynamicClusterPool<Data, Response>
@@ -150,19 +157,20 @@ When the maximum number of workers is reached and workers are busy, an event is
Overrides FixedClusterPool.constructor
- Defined in src/pools/cluster/dynamic.ts:27

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

Properties

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Emitter on which events can be listened to.

`Optional` emitter

emitter?: 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.
'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.
'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.
'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:74

`Protected` `Readonly` filePath

filePath: string

@@ -180,7 +188,7 @@ When the maximum number of workers is reached and workers are busy, an event is

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

`Protected` `Readonly` max

max: number

@@ -189,7 +197,7 @@ When the maximum number of workers is reached and workers are busy, an event is

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

`Protected` `Readonly` numberOfWorkers

numberOfWorkers: number

@@ -198,7 +206,7 @@ When the maximum number of workers is reached and workers are busy, an event is

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

`Protected` `Readonly` opts

opts: ClusterPoolOptions = {}

@@ -207,11 +215,11 @@ When the maximum number of workers is reached and workers are busy, an event is

Defined in src/pools/cluster/fixed.ts:47

`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:88

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

@@ -230,7 +238,7 @@ When the maximum number of workers is reached and workers are busy, an event is

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

`Readonly` `Internal` workerNodes

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

@@ -239,7 +247,7 @@ When the maximum number of workers is reached and workers are busy, an event is

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

Accessors

@@ -254,7 +262,7 @@ When the maximum number of workers is reached and workers are busy, an event is

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

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 FixedClusterPool.addTaskFunction
+
- Defined in src/pools/abstract-pool.ts:804

`Protected` afterTaskExecutionHook

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

`Protected` afterWorkerNodeSetup

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

`Protected` beforeTaskExecutionHook

`Protected` checkDynamicPoolSize

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

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

`Protected` createAndSetupDynamicWorkerNode

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

`Protected` createAndSetupWorkerNode

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

`Protected` createWorker

Defined in src/pools/cluster/fixed.ts:125

`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 FixedClusterPool.deregisterWorkerMessageListener
+
- Defined in src/pools/cluster/fixed.ts:117

destroy

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

`Protected` destroyWorkerNode

Defined in src/pools/cluster/fixed.ts:63

enableTasksQueue

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

execute

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

`Protected` flagWorkerNodeAsNotReady

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

`Protected` flushTasksQueue

Returns void

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

`Protected` getWorkerInfo

getWorkerInfo(workerNodeKey): undefined | WorkerInfo
getWorkerInfo(workerNodeKey): WorkerInfo
Gets the worker information given its worker node key.

@@ -601,12 +679,33 @@ Can be overridden.

The worker node key.

Returns undefined | WorkerInfo

The worker information.

Returns WorkerInfo

The worker information.

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

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 FixedClusterPool.hasTaskFunction
+
- Defined in src/pools/abstract-pool.ts:791

hasWorkerNodeBackPressure

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

`Protected` internalBusy

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

`Protected` isMain

listTaskFunctions

Defined in src/pools/cluster/fixed.ts:58

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.
-
Inherited from FixedClusterPool.listTaskFunctions
+
Inherited from FixedClusterPool.listTaskFunctionNames
+
- Defined in src/pools/abstract-pool.ts:843

`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 FixedClusterPool.registerOnceWorkerMessageListener
- Defined in src/pools/abstract-pool.ts:712

Defined in src/pools/cluster/fixed.ts:109

`Protected` registerWorkerMessageListener

Defined in src/pools/cluster/fixed.ts:101

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 FixedClusterPool.removeTaskFunction
+
- Defined in src/pools/abstract-pool.ts:827

`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:959

`Protected` sendStartupMessageToWorker

Defined in src/pools/cluster/fixed.ts:94

`Protected` sendToWorker

Defined in src/pools/cluster/fixed.ts:83

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 FixedClusterPool.setDefaultTaskFunction
+
- Defined in src/pools/abstract-pool.ts:856

setTasksQueueOptions

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

setWorkerChoiceStrategy

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

setWorkerChoiceStrategyOptions

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

`Protected` setupHook

`Protected` workerListener

workerListener(): ((message) => void)
Defined in src/pools/cluster/fixed.ts:53

start

start(): void
-
This method is the listener registered for each worker message.
+
Starts the minimum number of workers in this pool.

-
Returns ((message) => void)
The listener function to execute when a message is received from a worker.
- -
- -
  - (message): void

`Protected` workerMessageListener

workerMessageListener(message): void
-
This method is the listener registered for each worker message.
+
This method is the message listener registered on each worker.
Parameters
- message: MessageValue<Response, unknown>
-
Returns void
The listener function to execute when a message is received from a worker.
- -

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 Internal workerNodes

Accessors

Protected full

info

Protected maxSize

Protected minSize

Private ready

Protected type

Private utilization

Protected worker

Methods

addTaskFunction

Parameters

name: string

fn: TaskFunction<Data, Response>

Returns Promise<boolean>

Throws

Throws

Protected afterTaskExecutionHook

Protected afterWorkerNodeSetup

Protected beforeTaskExecutionHook

Protected checkDynamicPoolSize

Parameters

min: number

max: number

Returns void

Protected createAndSetupDynamicWorkerNode

Protected createAndSetupWorkerNode

Protected createWorker

Protected deregisterWorkerMessageListener

Type Parameters

Message

Parameters

workerNodeKey: number

listener: ((message) => void)

Parameters

message: MessageValue<Message, unknown>

Returns void

Returns void

destroy

Protected destroyWorkerNode

enableTasksQueue

execute

Protected flagWorkerNodeAsNotReady

Parameters

workerNodeKey: number

Returns void

Protected flushTasksQueue

Returns void

Protected getWorkerInfo

Returns undefined | WorkerInfo

Returns WorkerInfo

hasTaskFunction

Parameters

name: string

Returns boolean

hasWorkerNodeBackPressure

Protected internalBusy

Protected isMain

listTaskFunctions

listTaskFunctionNames

Returns string[]

`Optional` `Readonly` emitter

`Optional` emitter

`Protected` `Readonly` filePath

`Protected` `Readonly` max

`Protected` `Readonly` numberOfWorkers

`Protected` `Readonly` opts

`Protected` promiseResponseMap

`Protected` workerChoiceStrategyContext

`Readonly` `Internal` workerNodes

`Protected` full

`Protected` maxSize

`Protected` minSize

`Private` ready

`Protected` type

`Private` utilization

`Protected` worker

`Protected` afterTaskExecutionHook

`Protected` afterWorkerNodeSetup

`Protected` beforeTaskExecutionHook

`Protected` checkDynamicPoolSize

`Protected` createAndSetupDynamicWorkerNode

`Protected` createAndSetupWorkerNode

`Protected` createWorker

`Protected` deregisterWorkerMessageListener

`Protected` destroyWorkerNode

`Protected` flagWorkerNodeAsNotReady

`Protected` flushTasksQueue

`Protected` getWorkerInfo

`Protected` internalBusy

`Protected` isMain

`Protected` registerOnceWorkerMessageListener

`Protected` registerWorkerMessageListener

`Protected` sendKillMessageToWorker

`Protected` sendStartupMessageToWorker

`Protected` sendToWorker

`Protected` setupHook

`Protected` workerListener

`Protected` workerMessageListener