DynamicThreadPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=e82807a8b47c6d16f4552699c965f4adef005eca;hb=f04db52f666beefda86a0444fb9a28d410211b3f;hp=62d4967497f54546e914007767913f7abfc1ca0c;hpb=b881e803f1a32ce8d8218d3ba3638ad317ae87bc;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 62d49674..e82807a8 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,4 +1,4 @@ -DynamicThreadPool | poolifier - v2.6.19

+DynamicThreadPool | poolifier - v2.6.20

@@ -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

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

Methods

afterTaskExecutionHook -afterWorkerSetup +afterWorkerNodeSetup beforeTaskExecutionHook checkDynamicPoolSize -createAndSetupDynamicWorker -createAndSetupWorker +createAndSetupDynamicWorkerNode +createAndSetupWorkerNode createWorker destroy -destroyWorker +destroyWorkerNode enableTasksQueue execute -getWorkerInfoByWorker -getWorkerNodeKey +flushTasksQueue +getWorkerInfo internalBusy isMain registerWorkerMessageListener @@ -147,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

@@ -166,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

@@ -175,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:104

`Protected` `Readonly` max

max: number

@@ -183,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

@@ -192,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:103

`Protected` `Readonly` opts

opts: ThreadPoolOptions = {}

@@ -201,11 +201,11 @@ 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>> = ...

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:74

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

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

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

`Readonly` workerNodes

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

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

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

Accessors

@@ -248,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

`Protected` full

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

info

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

`Protected` maxSize

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

Returns number
Overrides FixedThreadPool.maxSize
- Defined in src/pools/thread/dynamic.ts:43

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

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

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

`Private` ready

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

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

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

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

`Private` utilization

get utilization(): number
-
Gets the approximate pool utilization.
+
The approximate pool utilization.

Returns number
The pool utilization.
Inherited from FixedThreadPool.utilization
- Defined in src/pools/abstract-pool.ts:447

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

`Protected` worker

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

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

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

Methods

`Protected` afterTaskExecutionHook

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

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

`Protected` afterWorkerSetup

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

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

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

`Protected` beforeTaskExecutionHook

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

`Protected` checkDynamicPoolSize

Returns void

`Protected` createAndSetupDynamicWorker

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

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

`Protected` createAndSetupWorker

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

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

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

`Protected` createWorker

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

destroy

destroy(): Promise<void>
-
Terminates 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:651

`Protected` destroyWorker

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

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

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

enableTasksQueue

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

execute

`Protected` getWorkerInfoByWorker

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

`Protected` flushTasksQueue

getWorkerInfoByWorker(worker): WorkerInfo
flushTasksQueue(workerNodeKey): void
-
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
+
workerNodeKey: number

Returns void

`Protected` getWorkerNodeKey

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

`Protected` getWorkerInfo

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

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

`Protected` internalBusy

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

`Protected` isMain

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

`Protected` registerWorkerMessageListener

registerWorkerMessageListener<Message>(worker, listener): void
registerWorkerMessageListener<Message>(workerNodeKey, listener): void
-
Registers a listener callback on the given worker.
+
Registers a listener callback on the worker given its worker node key.
Type Parameters
@@ -643,8 +637,8 @@ Can be overridden.

Parameters
- -
  worker: Worker
  -
  The worker which should register a listener.
  +
  workerNodeKey: number
  +
  The worker node key.
- @@ -667,40 +661,40 @@ Can be overridden.
  Inherited from FixedThreadPool.registerWorkerMessageListener
  
  -
  Defined in src/pools/thread/fixed.ts:88
+
Defined in src/pools/thread/fixed.ts:102

`Protected` sendStartupMessageToWorker

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

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

`Protected` sendToWorker

sendToWorker(worker, message): void
sendToWorker(workerNodeKey, message): 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.
- @@ -712,7 +706,7 @@ Can be overridden.
  Inherited from FixedThreadPool.sendToWorker
  
  -
  Defined in src/pools/thread/fixed.ts:66

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

`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.
@@ -805,7 +799,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
  @@ -818,7 +812,7 @@ Can be overridden.
  
  Inherited from FixedThreadPool.workerListener
  
  -
  Defined in src/pools/abstract-pool.ts:992

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

worker: Worker

workerNodeKey: number

worker: Worker

workerNodeKey: number

worker: Worker

workerNodeKey: number

workerNodeKey: number

workerNodeKey: number

workerNodeKey: number

workerNodeKey: number

Parameters