X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=c6bf43baf88ac70a2be1d8227bf86ad1f2d9a5f8;hb=6d6c7ed0c2c3c83cefae4d8cd5bc9393126bba70;hp=bfa752b016c70c08f6c19489ac441859b48808f9;hpb=a6d9dccfaf39e185c896747260d668fcb683a8ed;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index bfa752b0..c6bf43ba 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+Defined in src/pools/abstract-pool.ts:46
@@ -141,7 +141,7 @@
Type Parameters
-
-
Worker extends IWorker<Worker>
+Worker extends IWorker
-
Data = unknown
-
@@ -167,7 +167,7 @@
Returns AbstractPool<Worker, Data, Response>
+Defined in src/pools/abstract-pool.ts:86
Protected
Readonly
filePath
filePath: string
@@ -193,7 +193,7 @@
+Defined in src/pools/abstract-pool.ts:88
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -201,7 +201,7 @@
+Defined in src/pools/abstract-pool.ts:87
Protected
Readonly
opts
@@ -209,7 +209,7 @@
+Defined in src/pools/abstract-pool.ts:89
Protected
promiseResponseMap
@@ -222,7 +222,7 @@
+Defined in src/pools/abstract-pool.ts:65
Protected
workerChoiceStrategyContext
@@ -230,7 +230,7 @@
+Defined in src/pools/abstract-pool.ts:73
Readonly
workerNodes
@@ -239,7 +239,7 @@
+Defined in src/pools/abstract-pool.ts:52
Protected
full
@@ -265,7 +265,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:390
+Defined in src/pools/abstract-pool.ts:240
Protected
Abstract
maxSize
@@ -288,7 +288,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:307
Protected
Abstract
minSize
@@ -299,7 +299,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:302
Protected
Abstract
type
@@ -311,7 +311,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:292
Protected
Abstract
worker
@@ -322,7 +322,7 @@
Returns "cluster" | "thread"
+Defined in src/pools/abstract-pool.ts:297
Protected
afterWorkerSetup
@@ -369,7 +369,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:696
Protected
beforeTaskExecutionHook
@@ -394,7 +394,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:488
Private
buildTasksQueueOptions
@@ -407,7 +407,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:377
Private
checkAndEmitEvents
@@ -415,7 +415,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:796
Private
checkFilePath
@@ -428,7 +428,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:123
Private
checkNumberOfWorkers
@@ -441,7 +441,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:132
Private
checkPoolOptions
@@ -454,7 +454,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:150
Private
checkValidTasksQueueOptions
@@ -467,7 +467,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:215
Private
checkValidWorkerChoiceStrategy
@@ -480,7 +480,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:177
Private
checkValidWorkerChoiceStrategyOptions
@@ -493,7 +493,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:187
Private
chooseWorkerNode
@@ -506,7 +506,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:638
Protected
createAndSetupDynamicWorker
@@ -518,7 +518,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:739
Protected
createAndSetupWorker
@@ -530,7 +530,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:706
Protected
Abstract
createWorker
@@ -542,7 +542,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:688
Private
dequeueTask
@@ -555,7 +555,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:883
+Defined in src/pools/abstract-pool.ts:449
Protected
Abstract
destroyWorker
@@ -586,7 +586,7 @@ Can be overridden.
Returns void | Promise<void>
+Defined in src/pools/abstract-pool.ts:464
+Defined in src/pools/abstract-pool.ts:355
Private
enqueueTask
@@ -626,7 +626,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:879
+Defined in src/pools/abstract-pool.ts:415
Private
executeTask
@@ -667,7 +667,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:874
Private
flushTasksQueue
@@ -680,7 +680,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:895
Private
flushTasksQueues
@@ -688,7 +688,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:907
Private
getWorkerNodeKey
@@ -704,11 +704,11 @@ Can be overridden.
-Returns number
The worker node key if the worker is found in the pool worker nodes, -1
otherwise.
+Returns number
The worker node key if found in the pool worker nodes, -1
otherwise.
+Defined in src/pools/abstract-pool.ts:315
Private
getWorkerUsage
@@ -721,7 +721,7 @@ Can be overridden.
Optional
workerNodeKey: number
+Defined in src/pools/abstract-pool.ts:925
Protected
internalBusy
@@ -733,7 +733,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:406
Protected
Abstract
isMain
@@ -744,7 +744,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:479
Private
pushWorkerNode
@@ -764,7 +764,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:826
Private
registerWorkerMessageListener
@@ -804,7 +804,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:676
Private
removeWorkerNode
@@ -823,7 +823,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:866
Protected
Abstract
sendToWorker
@@ -847,7 +847,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:665
+Defined in src/pools/abstract-pool.ts:367
+Defined in src/pools/abstract-pool.ts:322
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:344
Private
setWorkerNodeTasksUsage
@@ -936,7 +936,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:813
Private
setWorkerStatistics
@@ -949,7 +949,7 @@ Can be overridden.
worker: Worker
Returns void
+Defined in src/pools/abstract-pool.ts:913
Protected
setupHook
@@ -961,7 +961,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:472
Private
shallCreateDynamicWorker
@@ -973,7 +973,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:655
Private
tasksMaxQueueSize
@@ -986,7 +986,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:891
Private
tasksQueueSize
@@ -999,7 +999,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:887
Private
updateEluWorkerUsage
@@ -1014,7 +1014,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:586
Private
updateRunTimeWorkerUsage
@@ -1029,7 +1029,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:526
Private
updateTaskStatisticsWorkerUsage
@@ -1044,7 +1044,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:514
Private
updateWaitTimeWorkerUsage
@@ -1059,7 +1059,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:555
Protected
workerListener
@@ -1086,7 +1086,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:764
+WorkerTypes
+availableParallelism
The worker.