X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=984c1c21c2da8ba185da4297fe494a7610100b85;hb=5c30b9d94384214b24f11ea7e68a54efaa6795b7;hp=c6bf43baf88ac70a2be1d8227bf86ad1f2d9a5f8;hpb=c4dfd49dbde2f3af0adc4a33d582b1c653f859b5;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index c6bf43ba..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
@@ -76,17 +78,22 @@
info
maxSize
minSize
+
ready
type
+
utilization
worker
+Defined in src/pools/abstract-pool.ts:107
Protected
promiseResponseMap
@@ -222,7 +234,23 @@
+Defined in src/pools/abstract-pool.ts:74
+
+Private
Readonly
startTimestamp
+startTimestamp: number
+
+
+
+Private
Readonly
starting
+starting: boolean
+
+
Protected
workerChoiceStrategyContext
@@ -230,16 +258,16 @@
+Defined in src/pools/abstract-pool.ts:82
+Defined in src/pools/abstract-pool.ts:61
Protected
full
@@ -265,7 +293,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:591
+Defined in src/pools/abstract-pool.ts:294
Protected
Abstract
maxSize
@@ -288,7 +316,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:483
Protected
Abstract
minSize
@@ -299,7 +327,15 @@
Returns number
+Defined in src/pools/abstract-pool.ts:478
+
+Private
ready
+
+- get ready(): boolean
+-
+
Returns boolean
Protected
Abstract
type
@@ -311,7 +347,19 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:468
+
+Private
utilization
+
+- get utilization(): number
+-
+
+
Returns number
The pool utilization.
+
+
Protected
Abstract
worker
@@ -322,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
@@ -349,7 +417,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:717
Protected
afterWorkerSetup
@@ -369,7 +437,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:941
Protected
beforeTaskExecutionHook
@@ -394,7 +462,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:696
Private
buildTasksQueueOptions
@@ -407,7 +475,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:578
Private
checkAndEmitEvents
@@ -415,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
@@ -428,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
@@ -441,7 +545,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:156
Private
checkPoolOptions
@@ -454,7 +558,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:192
Private
checkValidTasksQueueOptions
@@ -467,7 +571,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:257
Private
checkValidWorkerChoiceStrategy
@@ -480,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
@@ -493,7 +597,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:229
Private
chooseWorkerNode
@@ -506,7 +610,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:812
Protected
createAndSetupDynamicWorker
@@ -518,7 +622,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:896
Protected
createAndSetupWorker
@@ -530,7 +634,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:856
Protected
Abstract
createWorker
@@ -542,7 +646,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:849
Private
dequeueTask
@@ -555,19 +659,19 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1118
destroy
- destroy(): Promise<void>
-
-
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
@@ -680,7 +790,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1126
Private
flushTasksQueues
@@ -688,10 +798,72 @@ Can be overridden.
-
Returns void
-
+
+
+Private
getWorkerInfo
+
+- getWorkerInfo(workerNodeKey): WorkerInfo
+-
+
+
+
Parameters
+
+-
+
workerNodeKey: number
+
+
+The worker information.
+
+
+
+Protected
getWorkerInfoByWorker
+
+- getWorkerInfoByWorker(worker): WorkerInfo
+-
+
+
+
The worker information.
+
+
+
+Protected
getWorkerNodeKey
+
- getWorkerNodeKey(worker): number
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1005
Protected
internalBusy
@@ -733,7 +918,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:607
Protected
Abstract
isMain
@@ -744,30 +929,23 @@ Can be overridden.
Returns boolean
-
+
+Private
redistributeQueuedTasks
-- pushWorkerNode(worker): number
+- redistributeQueuedTasks(workerNodeKey): void
-
-
-
Returns number
The worker nodes length.
-
-
+Returns void
-
-Private
registerWorkerMessageListener
-
+
+Protected
Abstract
registerWorkerMessageListener
+
- registerWorkerMessageListener<Message>(worker, listener): void
-
Returns void
+Defined in src/pools/abstract-pool.ts:1142
Protected
setupHook
@@ -961,7 +1134,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:680
Private
shallCreateDynamicWorker
@@ -973,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
@@ -999,7 +1167,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1122
Private
updateEluWorkerUsage
@@ -1014,7 +1182,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:773
Private
updateRunTimeWorkerUsage
@@ -1029,7 +1197,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:747
Private
updateTaskStatisticsWorkerUsage
@@ -1044,7 +1212,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:734
Private
updateWaitTimeWorkerUsage
@@ -1059,7 +1227,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:759
Protected
workerListener
@@ -1086,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:
-
-
+
+
+
@@ -185,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