DynamicThreadPool | poolifier

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

DynamicThreadPool

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

@@ -73,6 +73,7 @@ When the maximum number of threads is reached and workers are busy, an event is info maxSize minSize +ready type utilization worker @@ -82,6 +83,7 @@ When the maximum number of threads is reached and workers are busy, an event is

afterTaskExecutionHook afterWorkerSetup beforeTaskExecutionHook +checkDynamicPoolSize createAndSetupDynamicWorker createAndSetupWorker createWorker @@ -89,8 +91,12 @@ When the maximum number of threads is reached and workers are busy, an event is destroyWorker enableTasksQueue execute +getWorkerInfoByWorker +getWorkerNodeKey internalBusy isMain +registerWorkerMessageListener +sendStartupMessageToWorker sendToWorker setTasksQueueOptions setWorkerChoiceStrategy @@ -141,7 +147,7 @@ When the maximum number of threads is reached and workers are busy, an event is

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

Properties

@@ -150,8 +156,9 @@ When the maximum number of threads is reached and workers are busy, an event is

Emitter on which events can be listened to.

Events that can currently be listened to:

'full': Emitted when the pool is dynamic and full.
'busy': Emitted when the pool is busy.
'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
'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.
'error': Emitted when an uncaught error occurs.
'taskError': Emitted when an error occurs while executing a task.

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

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

`Protected` `Readonly` filePath

filePath: string

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

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

`Protected` `Readonly` max

max: number

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

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

`Protected` `Readonly` numberOfWorkers

numberOfWorkers: number

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

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

`Protected` `Readonly` opts

opts: ThreadPoolOptions = {}

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

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

`Protected` promiseResponseMap

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

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

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

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

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

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

`Readonly` workerNodes

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

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

Pool worker nodes.

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

Accessors

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

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

`Private` ready

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

`Protected` type

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

`Private` utilization

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

`Protected` worker

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

Methods

@@ -356,7 +372,7 @@ Can be overridden.

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

`Protected` afterWorkerSetup

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

`Protected` beforeTaskExecutionHook

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

`Protected` checkDynamicPoolSize

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

`Protected` createAndSetupDynamicWorker

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

`Protected` createAndSetupWorker

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

`Protected` createWorker

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

destroy

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

`Protected` destroyWorker

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

enableTasksQueue

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

execute

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

`Protected` getWorkerInfoByWorker

getWorkerInfoByWorker(worker): WorkerInfo
+
Gets the worker information from the given worker.
+
+
+
Parameters
+
- +
  worker: Worker
  +
  The worker.
  +
  +
+
Returns WorkerInfo
The worker information.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-error If the worker is not found.
+
+
Inherited from FixedThreadPool.getWorkerInfoByWorker
+
- Defined in src/pools/abstract-pool.ts:1067

`Protected` getWorkerNodeKey

getWorkerNodeKey(worker): number
+
Gets the given worker its worker node key.
+
+
+
Parameters
+
- +
  worker: Worker
  +
  The worker.
  +
  +
+
Returns number
The worker node key if found in the pool worker nodes, -1 otherwise.
+ +
+
Inherited from FixedThreadPool.getWorkerNodeKey
+
- Defined in src/pools/abstract-pool.ts:519

`Protected` internalBusy

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

`Protected` isMain

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

`Protected` registerWorkerMessageListener

registerWorkerMessageListener<Message>(worker, listener): void
+
Registers a listener callback on the given worker.
+
+
+
Type Parameters
+
- +
  Message
+
+
Parameters
+
- +
  worker: Worker
  +
  The worker which should register a listener.
  +
  +
- +
  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:88

`Protected` sendStartupMessageToWorker

sendStartupMessageToWorker(worker): void
+
Sends the startup message to the given worker.
+
+
+
Parameters
+
- +
  worker: Worker
  +
  The worker which should receive the startup message.
  +
  +
+
Returns void
+
+
Inherited from FixedThreadPool.sendStartupMessageToWorker
+
- Defined in src/pools/thread/fixed.ts:73

`Protected` sendToWorker

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

setTasksQueueOptions

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

setWorkerChoiceStrategy

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

setWorkerChoiceStrategyOptions

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

`Protected` setupHook

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

Parameters

message: MessageValue<Message, unknown>

Returns void