DynamicClusterPool | poolifier

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

DynamicClusterPool

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

@@ -84,10 +84,10 @@ When the maximum number of workers is reached and workers are busy, an event is afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook -checkDynamicPoolSize createAndSetupDynamicWorkerNode createAndSetupWorkerNode createWorker +deregisterWorkerMessageListener destroy destroyWorkerNode enableTasksQueue @@ -99,6 +99,7 @@ When the maximum number of workers is reached and workers are busy, an event is internalBusy isMain listTaskFunctionNames +registerOnceWorkerMessageListener registerWorkerMessageListener removeTaskFunction sendKillMessageToWorker @@ -155,13 +156,14 @@ When the maximum number of workers is reached and workers are busy, an event is

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?: __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

@@ -185,7 +187,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` max

max: number

@@ -194,7 +196,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

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

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

`Protected` `Readonly` opts

opts: ClusterPoolOptions = {}

@@ -212,7 +214,7 @@ 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>> = ...

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

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

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

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

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

`Readonly` `Internal` workerNodes

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

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

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

Accessors

@@ -259,7 +261,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

@@ -391,7 +393,7 @@ If a task function with the same name already exists, it will be overwritten.

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

`Protected` afterTaskExecutionHook

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

`Protected` afterWorkerNodeSetup

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

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

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

`Protected` createAndSetupDynamicWorkerNode

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

`Protected` createAndSetupWorkerNode

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

`Protected` createWorker

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

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

destroy

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

`Protected` destroyWorkerNode

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

enableTasksQueue

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

execute

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

`Protected` flushTasksQueue

Returns void

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

`Protected` getWorkerInfo

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

hasTaskFunction

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

hasWorkerNodeBackPressure

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

`Protected` internalBusy

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

`Protected` isMain

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

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