X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=73bf3040ac4380bf133f77fc08991e8b5452c246;hb=44c8c00f7a09dcc4a1986e66a83abad3a603d83b;hp=4782daeebb94564871a2e6088604d5a99b48fea0;hpb=202bcb6b999895ba5c5ef42eccd6a95836d21602;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 4782daee..73bf3040 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier
+AbstractPool | poolifier - v2.6.11
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:49
@@ -77,7 +77,8 @@
info
maxSize
minSize
-runTime
+ready
+starting
type
utilization
worker
@@ -89,7 +90,9 @@
beforeTaskExecutionHook
buildTasksQueueOptions
checkAndEmitEvents
+checkDynamicPoolSize
checkFilePath
+checkMessageWorkerId
checkNumberOfWorkers
checkPoolOptions
checkValidTasksQueueOptions
@@ -109,25 +112,23 @@
flushTasksQueue
flushTasksQueues
getWorkerById
-getWorkerId
+getWorkerInfo
getWorkerNodeKey
-getWorkerUsage
handleTaskExecutionResponse
-handleWorkerStartedMessage
+handleWorkerReadyMessage
internalBusy
isMain
pushWorkerNode
+redistributeQueuedTasks
registerWorkerMessageListener
removeWorkerNode
sendToWorker
setTasksQueueOptions
setWorkerChoiceStrategy
setWorkerChoiceStrategyOptions
-setWorkerNodeTasksUsage
setWorkerStatistics
setupHook
shallCreateDynamicWorker
-tasksMaxQueueSize
tasksQueueSize
updateEluWorkerUsage
updateRunTimeWorkerUsage
@@ -174,7 +175,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:94
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -208,7 +210,7 @@
+
Defined in src/pools/abstract-pool.ts:95
Protected
Readonly
opts
@@ -216,7 +218,7 @@
+Defined in src/pools/abstract-pool.ts:97
Protected
promiseResponseMap
@@ -229,7 +231,7 @@
+Defined in src/pools/abstract-pool.ts:68
Private
Readonly
startTimestamp
startTimestamp: number
@@ -237,7 +239,7 @@
+Defined in src/pools/abstract-pool.ts:85
Protected
workerChoiceStrategyContext
@@ -245,16 +247,16 @@
+Defined in src/pools/abstract-pool.ts:76
+Defined in src/pools/abstract-pool.ts:55
Protected
full
@@ -280,7 +282,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:562
+Defined in src/pools/abstract-pool.ts:268
Protected
Abstract
maxSize
@@ -303,7 +305,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:460
Protected
Abstract
minSize
@@ -314,19 +316,23 @@
Returns number
-
+
+Defined in src/pools/abstract-pool.ts:412
+
+Private
starting
+
+- get starting(): boolean
+-
+
Returns boolean
Protected
Abstract
type
@@ -338,7 +344,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:445
+Defined in src/pools/abstract-pool.ts:424
Protected
Abstract
worker
@@ -361,7 +367,7 @@
Returns "cluster" | "thread"
+Defined in src/pools/abstract-pool.ts:450
Protected
afterWorkerSetup
@@ -408,7 +414,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:911
Protected
beforeTaskExecutionHook
@@ -433,7 +439,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:667
Private
buildTasksQueueOptions
@@ -446,7 +452,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:549
Private
checkAndEmitEvents
@@ -454,7 +460,22 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1074
+
+Protected
checkDynamicPoolSize
+
+- checkDynamicPoolSize(min, max): void
+-
+
+
Parameters
+
+-
+
min: number
+-
+
max: number
+Returns void
Private
checkFilePath
@@ -467,7 +488,20 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:133
+
+Private
checkMessageWorkerId
+
+- checkMessageWorkerId(message): void
+-
+
+
Returns void
Private
checkNumberOfWorkers
@@ -480,7 +514,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:142
Private
checkPoolOptions
@@ -493,7 +527,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:178
Private
checkValidTasksQueueOptions
@@ -506,7 +540,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:243
Private
checkValidWorkerChoiceStrategy
@@ -519,7 +553,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:205
Private
checkValidWorkerChoiceStrategyOptions
@@ -532,7 +566,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:215
Private
chooseWorkerNode
@@ -545,7 +579,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:853
Protected
createAndSetupDynamicWorker
@@ -557,7 +591,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:994
Protected
createAndSetupWorker
@@ -569,7 +603,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:928
Protected
Abstract
createWorker
@@ -581,7 +615,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:903
Private
dequeueTask
@@ -594,7 +628,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1126
+Defined in src/pools/abstract-pool.ts:622
Protected
Abstract
destroyWorker
@@ -625,7 +659,7 @@ Can be overridden.
Returns void | Promise<void>
+Defined in src/pools/abstract-pool.ts:643
+Defined in src/pools/abstract-pool.ts:527
Private
enqueueTask
@@ -665,7 +699,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1122
+Defined in src/pools/abstract-pool.ts:587
Private
executeTask
@@ -706,7 +740,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:1117
Private
flushTasksQueue
@@ -719,7 +753,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1134
Private
flushTasksQueues
@@ -727,7 +761,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1144
Private
getWorkerById
@@ -747,27 +781,26 @@ Can be overridden.
-
+
+Private
getWorkerInfo
-- getWorkerId(worker): undefined | number
+- getWorkerInfo(workerNodeKey): WorkerInfo
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:1150
Protected
setupHook
@@ -1066,7 +1075,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:651
Private
shallCreateDynamicWorker
@@ -1078,20 +1087,7 @@ Can be overridden.
-
-Private
tasksMaxQueueSize
-
-- tasksMaxQueueSize(workerNodeKey): number
--
-
-
Returns number
+Defined in src/pools/abstract-pool.ts:870
Private
tasksQueueSize
@@ -1104,7 +1100,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1130
Private
updateEluWorkerUsage
@@ -1119,7 +1115,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:782
Private
updateRunTimeWorkerUsage
@@ -1134,7 +1130,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:706
Private
updateTaskStatisticsWorkerUsage
@@ -1149,7 +1145,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:693
Private
updateWaitTimeWorkerUsage
@@ -1164,7 +1160,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:744
Protected
workerListener
@@ -1191,7 +1187,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1025
Emitter on which events can be listened to.
Events that can currently be listened to:
-
-
+
+
+
@@ -192,7 +194,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