X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=800d4a3cda8c167931058f5b209aa9f93238ebb6;hb=2826fc7a3ba7197b08fe5c352d8965b234f3abc5;hp=c6bf43baf88ac70a2be1d8227bf86ad1f2d9a5f8;hpb=d33d2d2fed43d102479c38cc28b496872665a90d;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index c6bf43ba..800d4a3c 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier
+AbstractPool | poolifier - v2.6.17
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:54
@@ -76,17 +78,22 @@
info
maxSize
minSize
+
ready
type
+
utilization
worker
+Defined in src/pools/abstract-pool.ts:106
Protected
promiseResponseMap
@@ -222,7 +233,23 @@
+Defined in src/pools/abstract-pool.ts:73
+
+Private
Readonly
startTimestamp
+startTimestamp: number
+
+
+
+Private
Readonly
starting
+starting: boolean
+
+
Protected
workerChoiceStrategyContext
@@ -230,16 +257,16 @@
+Defined in src/pools/abstract-pool.ts:81
+Defined in src/pools/abstract-pool.ts:60
Protected
full
@@ -265,7 +292,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:590
+Defined in src/pools/abstract-pool.ts:293
Protected
Abstract
maxSize
@@ -288,7 +315,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:482
Protected
Abstract
minSize
@@ -299,7 +326,15 @@
Returns number
+Defined in src/pools/abstract-pool.ts:477
+
+Private
ready
+
+- get ready(): boolean
+-
+
Returns boolean
Protected
Abstract
type
@@ -311,7 +346,19 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:467
+
+Private
utilization
+
+- get utilization(): number
+-
+
+
Returns number
The pool utilization.
+
+
Protected
Abstract
worker
@@ -322,9 +369,29 @@
Returns "cluster" | "thread"
+Defined in src/pools/abstract-pool.ts:472
Methods
+
+Private
addWorkerNode
+
+- addWorkerNode(worker): number
+-
+
+
+
Returns number
The worker nodes length.
+
+
Protected
afterTaskExecutionHook
@@ -349,7 +416,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:716
Protected
afterWorkerSetup
@@ -369,7 +436,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1024
Protected
beforeTaskExecutionHook
@@ -394,7 +461,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:695
Private
buildTasksQueueOptions
@@ -407,7 +474,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:577
Private
checkAndEmitEvents
@@ -415,7 +482,22 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1122
+
+Protected
checkDynamicPoolSize
+
+- checkDynamicPoolSize(min, max): void
+-
+
+
Parameters
+
+-
+
min: number
+-
+
max: number
+Returns void
Private
checkFilePath
@@ -428,7 +510,28 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:142
+
+Private
checkMessageWorkerId
+
+- checkMessageWorkerId(message): void
+-
+
+
+
Returns void
+
Private
checkNumberOfWorkers
@@ -441,7 +544,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:155
Private
checkPoolOptions
@@ -454,7 +557,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:191
Private
checkValidTasksQueueOptions
@@ -467,7 +570,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:256
Private
checkValidWorkerChoiceStrategy
@@ -480,7 +583,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:218
Private
checkValidWorkerChoiceStrategyOptions
@@ -493,7 +596,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:228
Private
chooseWorkerNode
@@ -506,7 +609,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:893
Protected
createAndSetupDynamicWorker
@@ -518,7 +621,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:976
Protected
createAndSetupWorker
@@ -530,7 +633,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:937
Protected
Abstract
createWorker
@@ -542,7 +645,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:930
Private
dequeueTask
@@ -555,19 +658,19 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1185
destroy
- destroy(): Promise<void>
-
-
Returns number
+Defined in src/pools/abstract-pool.ts:1181
+Defined in src/pools/abstract-pool.ts:615
Private
executeTask
- executeTask(workerNodeKey, task): void
-
+
Parameters
-
workerNodeKey: number
-
-
task: Task<Data>
-Returns void
+Returns void
+
+Defined in src/pools/abstract-pool.ts:1176
Private
flushTasksQueue
@@ -680,7 +789,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1193
Private
flushTasksQueues
@@ -688,7 +797,46 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1203
+
+
+Private
getWorkerInfo
+
+- getWorkerInfo(workerNodeKey): WorkerInfo
+-
+
+
+
Parameters
+
+-
+
workerNodeKey: number
+
+
+
+
Private
getWorkerNodeKey
@@ -708,20 +856,33 @@ Can be overridden.
-
+
+Private
handleTaskExecutionResponse
-- getWorkerUsage(workerNodeKey?): WorkerUsage
+- handleTaskExecutionResponse(message): void
-
Parameters
-
-
Optional
workerNodeKey: number
-
+Returns void
+Defined in src/pools/abstract-pool.ts:1097
+
+Private
handleWorkerReadyResponse
+
+- handleWorkerReadyResponse(message): void
+-
+
+
Returns void
Protected
internalBusy
@@ -733,7 +894,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:606
Protected
Abstract
isMain
@@ -744,27 +905,20 @@ Can be overridden.
Returns boolean
-
+
+Private
redistributeQueuedTasks
-- pushWorkerNode(worker): number
+- redistributeQueuedTasks(workerNodeKey): void
-
-
-
Returns number
The worker nodes length.
-
-
+Returns void
+Defined in src/pools/abstract-pool.ts:1040
Private
registerWorkerMessageListener
@@ -804,7 +958,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1011
Private
removeWorkerNode
@@ -823,7 +977,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1162
Protected
Abstract
sendToWorker
@@ -847,7 +1001,20 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:920
+
+Private
sendWorkerStartupMessage
+
+- sendWorkerStartupMessage(worker): void
+-
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:567
+Defined in src/pools/abstract-pool.ts:525
setWorkerChoiceStrategyOptions
-
-Private
setWorkerNodeTasksUsage
-
-- setWorkerNodeTasksUsage(workerNode, workerUsage): void
--
-
-
-
Parameters
-
--
-
workerNode: WorkerNode<Worker, Data>
-
-
--
-
-
-
-Returns void
-
+Defined in src/pools/abstract-pool.ts:544
Private
setWorkerStatistics
@@ -949,7 +1092,7 @@ Can be overridden.
worker: Worker
Returns void
+Defined in src/pools/abstract-pool.ts:1209
Protected
setupHook
@@ -961,7 +1104,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:679
Private
shallCreateDynamicWorker
@@ -973,20 +1116,15 @@ Can be overridden.
-
+
+Private
startPool
-- tasksMaxQueueSize(workerNodeKey): number
+- startPool(): void
-
-
-
Returns number
+Defined in src/pools/abstract-pool.ts:280
Private
tasksQueueSize
@@ -999,7 +1137,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1189
Private
updateEluWorkerUsage
@@ -1014,7 +1152,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:822
Private
updateRunTimeWorkerUsage
@@ -1029,7 +1167,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:746
Private
updateTaskStatisticsWorkerUsage
@@ -1044,7 +1182,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:733
Private
updateWaitTimeWorkerUsage
@@ -1059,7 +1197,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:784
Protected
workerListener
@@ -1086,7 +1224,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1075
Emitter on which events can be listened to.
Events that can currently be listened to:
-
-
+
+
+
@@ -185,7 +196,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