X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=984c1c21c2da8ba185da4297fe494a7610100b85;hb=5c30b9d94384214b24f11ea7e68a54efaa6795b7;hp=c7e8d6be55d94a4688dfb99cbfdfef74f3ad3f0f;hpb=ac2cb9e206b5e67cc52124eb334507f5dce230d5;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index c7e8d6be..984c1c21 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier
+AbstractPool | poolifier - v2.6.19
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:55
@@ -77,19 +78,22 @@
info
maxSize
minSize
-
runTime
+
ready
type
utilization
worker
+Defined in src/pools/abstract-pool.ts:107
Protected
promiseResponseMap
@@ -229,7 +234,7 @@
+Defined in src/pools/abstract-pool.ts:74
Private
Readonly
startTimestamp
startTimestamp: number
@@ -237,7 +242,15 @@
+Defined in src/pools/abstract-pool.ts:95
+
+Private
Readonly
starting
+starting: boolean
+
+
Protected
workerChoiceStrategyContext
@@ -245,16 +258,16 @@
+Defined in src/pools/abstract-pool.ts:82
+Defined in src/pools/abstract-pool.ts:61
Protected
full
@@ -280,7 +293,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:591
+Defined in src/pools/abstract-pool.ts:294
Protected
Abstract
maxSize
@@ -303,7 +316,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:483
Protected
Abstract
minSize
@@ -314,19 +327,15 @@
Returns number
-
+
+Defined in src/pools/abstract-pool.ts:430
Protected
Abstract
type
@@ -338,7 +347,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:468
+Defined in src/pools/abstract-pool.ts:447
Protected
Abstract
worker
@@ -361,9 +370,29 @@
Returns "cluster" | "thread"
+Defined in src/pools/abstract-pool.ts:473
Methods
+
+Private
addWorkerNode
+
+- addWorkerNode(worker): number
+-
+
+
+
Returns number
The worker nodes length.
+
+
Protected
afterTaskExecutionHook
@@ -388,7 +417,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:717
Protected
afterWorkerSetup
@@ -408,7 +437,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:941
Protected
beforeTaskExecutionHook
@@ -433,7 +462,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:696
Private
buildTasksQueueOptions
@@ -446,7 +475,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:578
Private
checkAndEmitEvents
@@ -454,7 +483,22 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1039
+
+Protected
checkDynamicPoolSize
+
+- checkDynamicPoolSize(min, max): void
+-
+
+
Parameters
+
+-
+
min: number
+-
+
max: number
+Returns void
Private
checkFilePath
@@ -467,7 +511,28 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:143
+
+Private
checkMessageWorkerId
+
+- checkMessageWorkerId(message): void
+-
+
+
+
Returns void
+
Private
checkNumberOfWorkers
@@ -480,7 +545,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:156
Private
checkPoolOptions
@@ -493,7 +558,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:192
Private
checkValidTasksQueueOptions
@@ -506,7 +571,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:257
Private
checkValidWorkerChoiceStrategy
@@ -519,7 +584,7 @@ Can be overridden.
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Returns void
+Defined in src/pools/abstract-pool.ts:219
Private
checkValidWorkerChoiceStrategyOptions
@@ -532,7 +597,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:229
Private
chooseWorkerNode
@@ -545,7 +610,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:812
Protected
createAndSetupDynamicWorker
@@ -557,7 +622,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:896
Protected
createAndSetupWorker
@@ -569,7 +634,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:856
Protected
Abstract
createWorker
@@ -581,7 +646,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:849
Private
dequeueTask
@@ -594,7 +659,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1118
+Defined in src/pools/abstract-pool.ts:651
Protected
Abstract
destroyWorker
@@ -625,7 +690,7 @@ Can be overridden.
Returns void | Promise<void>
+Defined in src/pools/abstract-pool.ts:672
+Defined in src/pools/abstract-pool.ts:556
Private
enqueueTask
@@ -665,7 +730,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1114
+Defined in src/pools/abstract-pool.ts:616
Private
executeTask
- executeTask(workerNodeKey, task): void
-
+
Parameters
-
workerNodeKey: number
-
-
task: Task<Data>
-Returns void
+Returns void
+
+Defined in src/pools/abstract-pool.ts:1109
Private
flushTasksQueue
@@ -719,7 +790,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1126
Private
flushTasksQueues
@@ -727,7 +798,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1136
Private
getWorkerById
@@ -747,33 +818,33 @@ Can be overridden.
-
+
+Private
getWorkerInfo
-- getWorkerId(worker): undefined | number
+- getWorkerInfo(workerNodeKey): WorkerInfo
-
-
+
Returns void
-
-Private
registerWorkerMessageListener
-
+
+Protected
Abstract
registerWorkerMessageListener
+
- registerWorkerMessageListener<Message>(worker, listener): void
-
Returns void
+Defined in src/pools/abstract-pool.ts:1142
Protected
setupHook
@@ -1066,7 +1134,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:680
Private
shallCreateDynamicWorker
@@ -1078,20 +1146,15 @@ Can be overridden.
-
+
+Private
startPool
-- tasksMaxQueueSize(workerNodeKey): number
+- startPool(): void
-
-
-
Returns number
+Defined in src/pools/abstract-pool.ts:281
Private
tasksQueueSize
@@ -1104,7 +1167,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1122
Private
updateEluWorkerUsage
@@ -1119,7 +1182,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:773
Private
updateRunTimeWorkerUsage
@@ -1134,7 +1197,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:747
Private
updateTaskStatisticsWorkerUsage
@@ -1149,7 +1212,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:734
Private
updateWaitTimeWorkerUsage
@@ -1164,7 +1227,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:759
Protected
workerListener
@@ -1191,7 +1254,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:992
Emitter on which events can be listened to.
Events that can currently be listened to:
-
-
+
+
+
@@ -192,7 +197,7 @@ +'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.Protected
Readonly
file