X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=47a0a827782a198519d53d82dfc98c9862be0784;hb=ef9f489c870680b9a754ab8e5b142b3f042a9ebb;hp=c6bf43baf88ac70a2be1d8227bf86ad1f2d9a5f8;hpb=d33d2d2fed43d102479c38cc28b496872665a90d;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index c6bf43ba..47a0a827 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier
+AbstractPool | poolifier - v2.6.12
+Defined in src/pools/abstract-pool.ts:98
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -201,7 +210,7 @@
+Defined in src/pools/abstract-pool.ts:99
Protected
Readonly
opts
@@ -209,7 +218,7 @@
+Defined in src/pools/abstract-pool.ts:101
Protected
promiseResponseMap
@@ -222,7 +231,15 @@
+Defined in src/pools/abstract-pool.ts:72
+
+Private
Readonly
startTimestamp
+startTimestamp: number
+
+
Protected
workerChoiceStrategyContext
@@ -230,16 +247,16 @@
+Defined in src/pools/abstract-pool.ts:80
+Defined in src/pools/abstract-pool.ts:59
Protected
full
@@ -265,7 +282,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:566
+Defined in src/pools/abstract-pool.ts:272
Protected
Abstract
maxSize
@@ -288,7 +305,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:464
Protected
Abstract
minSize
@@ -299,7 +316,23 @@
Returns number
+Defined in src/pools/abstract-pool.ts:459
+
+Private
ready
+
+- get ready(): boolean
+-
+
Returns boolean
+
+Private
starting
+
+- get starting(): boolean
+-
+
Returns boolean
Protected
Abstract
type
@@ -311,7 +344,19 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:449
+
+Private
utilization
+
+- get utilization(): number
+-
+
+
Returns number
The pool utilization.
+
+
Protected
Abstract
worker
@@ -322,7 +367,7 @@
Returns "cluster" | "thread"
+Defined in src/pools/abstract-pool.ts:454
Protected
afterWorkerSetup
@@ -369,7 +414,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:927
Protected
beforeTaskExecutionHook
@@ -394,7 +439,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:671
Private
buildTasksQueueOptions
@@ -407,7 +452,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:553
Private
checkAndEmitEvents
@@ -415,7 +460,22 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1090
+
+Protected
checkDynamicPoolSize
+
+- checkDynamicPoolSize(min, max): void
+-
+
+
Parameters
+
+-
+
min: number
+-
+
max: number
+Returns void
Private
checkFilePath
@@ -428,7 +488,20 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:137
+
+Private
checkMessageWorkerId
+
+- checkMessageWorkerId(message): void
+-
+
+
Returns void
Private
checkNumberOfWorkers
@@ -441,7 +514,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:146
Private
checkPoolOptions
@@ -454,7 +527,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:182
Private
checkValidTasksQueueOptions
@@ -467,7 +540,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:247
Private
checkValidWorkerChoiceStrategy
@@ -480,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:209
Private
checkValidWorkerChoiceStrategyOptions
@@ -493,7 +566,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:219
Private
chooseWorkerNode
@@ -506,7 +579,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:869
Protected
createAndSetupDynamicWorker
@@ -518,7 +591,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1010
Protected
createAndSetupWorker
@@ -530,7 +603,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:944
Protected
Abstract
createWorker
@@ -542,7 +615,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:919
Private
dequeueTask
@@ -555,19 +628,19 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1142
destroy
- destroy(): Promise<void>
-
-
Returns number
+Defined in src/pools/abstract-pool.ts:1138
+Defined in src/pools/abstract-pool.ts:591
Private
executeTask
@@ -667,7 +740,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:1133
Private
flushTasksQueue
@@ -680,7 +753,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1150
Private
flushTasksQueues
@@ -688,7 +761,46 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1160
+
+
+Private
getWorkerInfo
+
+- getWorkerInfo(workerNodeKey): WorkerInfo
+-
+
+
+
Parameters
+
+-
+
workerNodeKey: number
+
+
+
+
Private
getWorkerNodeKey
@@ -708,20 +820,33 @@ Can be overridden.
-
+
+Private
handleTaskExecutionResponse
+
+- handleTaskExecutionResponse(message): void
+-
+
+
Returns void
+
+Private
handleWorkerReadyMessage
-- getWorkerUsage(workerNodeKey?): WorkerUsage
+- handleWorkerReadyMessage(message): void
-
Parameters
-
-
Optional
workerNodeKey: number
-
+Returns void
+Defined in src/pools/abstract-pool.ts:1054
Protected
internalBusy
@@ -733,7 +858,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:582
Protected
Abstract
isMain
@@ -744,7 +869,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:662
Private
pushWorkerNode
@@ -764,7 +889,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1116
+
+Private
redistributeQueuedTasks
+
+- redistributeQueuedTasks(worker): void
+-
+
+
Returns void
Private
registerWorkerMessageListener
@@ -804,7 +942,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:907
Private
removeWorkerNode
@@ -823,7 +961,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1125
Protected
Abstract
sendToWorker
@@ -847,7 +985,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:896
+Defined in src/pools/abstract-pool.ts:543
+Defined in src/pools/abstract-pool.ts:501
setWorkerChoiceStrategyOptions
-
-Private
setWorkerNodeTasksUsage
-
-- setWorkerNodeTasksUsage(workerNode, workerUsage): void
--
-
-
-
Parameters
-
--
-
workerNode: WorkerNode<Worker, Data>
-
-
--
-
-
-
-Returns void
-
+Defined in src/pools/abstract-pool.ts:520
Private
setWorkerStatistics
@@ -949,7 +1063,7 @@ Can be overridden.
worker: Worker
Returns void
+Defined in src/pools/abstract-pool.ts:1166
Protected
setupHook
@@ -961,7 +1075,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:655
Private
shallCreateDynamicWorker
@@ -973,20 +1087,7 @@ Can be overridden.
-
-Private
tasksMaxQueueSize
-
-- tasksMaxQueueSize(workerNodeKey): number
--
-
-
Returns number
+Defined in src/pools/abstract-pool.ts:886
Private
tasksQueueSize
@@ -999,7 +1100,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1146
Private
updateEluWorkerUsage
@@ -1014,7 +1115,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:798
Private
updateRunTimeWorkerUsage
@@ -1029,7 +1130,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:722
Private
updateTaskStatisticsWorkerUsage
@@ -1044,7 +1145,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:709
Private
updateWaitTimeWorkerUsage
@@ -1059,7 +1160,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:760
Protected
workerListener
@@ -1086,7 +1187,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1041
Emitter on which events can be listened to.
Events that can currently be listened to:
-
-
+
+
+
@@ -185,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