X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=984c1c21c2da8ba185da4297fe494a7610100b85;hb=5c30b9d94384214b24f11ea7e68a54efaa6795b7;hp=fc48e1e3b8b729e64d2b82febe1a6ce7e1d98a23;hpb=08e40091fb1d27284ffcdfaced81292139a02c55;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index fc48e1e3..984c1c21 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.13
+AbstractPool | poolifier - v2.6.19
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:55
@@ -78,14 +79,14 @@
maxSize
minSize
ready
-
starting
type
utilization
worker
Methods
-afterTaskExecutionHook
+
addWorkerNode
+
afterTaskExecutionHook
afterWorkerSetup
beforeTaskExecutionHook
buildTasksQueueOptions
@@ -113,15 +114,16 @@
flushTasksQueues
getWorkerById
getWorkerInfo
-
getWorkerNodeKey
+
getWorkerInfoByWorker
+
getWorkerNodeKey
handleTaskExecutionResponse
-
handleWorkerReadyMessage
+
handleWorkerReadyResponse
internalBusy
isMain
-
pushWorkerNode
redistributeQueuedTasks
-
registerWorkerMessageListener
+
registerWorkerMessageListener
removeWorkerNode
+
sendStartupMessageToWorker
sendToWorker
setTasksQueueOptions
setWorkerChoiceStrategy
@@ -129,6 +131,7 @@
setWorkerStatistics
setupHook
shallCreateDynamicWorker
+
startPool
tasksQueueSize
updateEluWorkerUsage
updateRunTimeWorkerUsage
@@ -175,7 +178,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:104
Protected
Readonly
filePath
filePath: string
@@ -202,7 +205,7 @@
+
Defined in src/pools/abstract-pool.ts:106
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -210,7 +213,7 @@
+Defined in src/pools/abstract-pool.ts:105
Protected
Readonly
opts
@@ -218,7 +221,7 @@
+Defined in src/pools/abstract-pool.ts:107
Protected
promiseResponseMap
@@ -231,7 +234,7 @@
+Defined in src/pools/abstract-pool.ts:74
Private
Readonly
startTimestamp
startTimestamp: number
@@ -239,7 +242,15 @@
+Defined in src/pools/abstract-pool.ts:95
+
+Private
Readonly
starting
+starting: boolean
+
+
Protected
workerChoiceStrategyContext
@@ -247,7 +258,7 @@
+Defined in src/pools/abstract-pool.ts:82
Readonly
workerNodes
@@ -256,7 +267,7 @@
+Defined in src/pools/abstract-pool.ts:61
Protected
full
@@ -282,7 +293,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:591
+Defined in src/pools/abstract-pool.ts:294
Protected
Abstract
maxSize
@@ -305,7 +316,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:483
Protected
Abstract
minSize
@@ -316,7 +327,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:478
Private
ready
@@ -324,15 +335,7 @@
-
Returns boolean
-
-Private
starting
-
-- get starting(): boolean
--
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:430
Protected
Abstract
type
@@ -344,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
@@ -367,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
@@ -394,7 +417,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:717
Protected
afterWorkerSetup
@@ -414,7 +437,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:941
Protected
beforeTaskExecutionHook
@@ -439,7 +462,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:696
Private
buildTasksQueueOptions
@@ -452,7 +475,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:578
Private
checkAndEmitEvents
@@ -460,7 +483,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1039
Protected
checkDynamicPoolSize
@@ -475,7 +498,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:174
Private
checkFilePath
@@ -488,20 +511,28 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:143
Private
checkMessageWorkerId
- checkMessageWorkerId(message): void
-
+
-
Returns void
+Returns void
+
+Defined in src/pools/abstract-pool.ts:502
Private
checkNumberOfWorkers
@@ -514,7 +545,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:156
Private
checkPoolOptions
@@ -527,7 +558,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:192
Private
checkValidTasksQueueOptions
@@ -540,7 +571,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:257
Private
checkValidWorkerChoiceStrategy
@@ -553,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
@@ -566,7 +597,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:229
Private
chooseWorkerNode
@@ -579,7 +610,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:812
Protected
createAndSetupDynamicWorker
@@ -591,7 +622,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:896
Protected
createAndSetupWorker
@@ -603,7 +634,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:856
Protected
Abstract
createWorker
@@ -615,7 +646,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:849
Private
dequeueTask
@@ -628,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
@@ -659,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
@@ -699,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
@@ -753,7 +790,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1126
Private
flushTasksQueues
@@ -761,7 +798,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1136
Private
getWorkerById
@@ -781,13 +818,13 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:491
Private
getWorkerInfo
- 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
@@ -1075,7 +1134,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:680
Private
shallCreateDynamicWorker
@@ -1087,7 +1146,15 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:829
+
+Private
startPool
+
+- startPool(): void
+-
+
Returns void
Private
tasksQueueSize
@@ -1100,7 +1167,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1122
Private
updateEluWorkerUsage
@@ -1115,7 +1182,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:773
Private
updateRunTimeWorkerUsage
@@ -1130,7 +1197,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:747
Private
updateTaskStatisticsWorkerUsage
@@ -1145,7 +1212,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:734
Private
updateWaitTimeWorkerUsage
@@ -1160,7 +1227,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:759
Protected
workerListener
@@ -1187,7 +1254,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:992
Whether the pool is starting or not.
+