X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FAbstractPool.html;h=0fbaae35c5292e27c894015d86e3dca4f3c753e8;hb=1ab50fe5ad0b27a13a48047f9414d4138d43a5cd;hp=fefd813870f27d18870841a4aa642465a9740322;hpb=8d98e603c79d8d00b2b6a33e5f732701a7466234;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index fefd8138..0fbaae35 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -45,7 +45,7 @@
- IPool<Worker, Data, Response>
+Defined in src/pools/abstract-pool.ts:38
@@ -153,7 +153,7 @@
Returns AbstractPool<Worker, Data, Response>
+Defined in src/pools/abstract-pool.ts:80
Protected
Readonly
filePath
filePath: string
+Defined in src/pools/abstract-pool.ts:82
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
+Defined in src/pools/abstract-pool.ts:81
+Defined in src/pools/abstract-pool.ts:83
Protected
promiseResponseMap
@@ -203,7 +203,7 @@
When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
+Defined in src/pools/abstract-pool.ts:57
Protected
workerChoiceStrategyContext
@@ -211,7 +211,7 @@
Default to a round robin algorithm.
+Defined in src/pools/abstract-pool.ts:67
Readonly
workerNodes
@@ -219,7 +219,7 @@
+Defined in src/pools/abstract-pool.ts:44
Protected
full
@@ -243,7 +243,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:360
+Defined in src/pools/abstract-pool.ts:215
Protected
Abstract
maxSize
@@ -264,7 +264,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:269
Protected
Abstract
minSize
@@ -274,7 +274,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:264
Protected
Abstract
type
@@ -285,7 +285,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:254
Protected
Abstract
worker
@@ -295,7 +295,7 @@
Returns "cluster" | "thread"
+Defined in src/pools/abstract-pool.ts:259
Protected
Abstract
afterWorkerSetup
@@ -337,7 +337,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:589
Protected
beforeTaskExecutionHook
@@ -355,7 +355,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:453
Private
buildTasksQueueOptions
@@ -368,7 +368,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:347
Private
checkAndEmitEvents
@@ -376,7 +376,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:663
Private
checkFilePath
@@ -389,7 +389,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:117
Private
checkNumberOfWorkers
@@ -402,7 +402,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:126
Private
checkPoolOptions
@@ -415,7 +415,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:144
Private
checkValidTasksQueueOptions
@@ -428,7 +428,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:199
Private
checkValidWorkerChoiceStrategy
@@ -441,7 +441,7 @@ Can be overridden.
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Returns void
+Defined in src/pools/abstract-pool.ts:171
Private
checkValidWorkerChoiceStrategyOptions
@@ -454,7 +454,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:181
Protected
chooseWorkerNode
@@ -466,7 +466,7 @@ Can be overridden.
Returns number
The worker node key
+Defined in src/pools/abstract-pool.ts:532
Protected
createAndSetupWorker
@@ -477,7 +477,7 @@ Can be overridden.
Returns Worker
New, completely set up worker.
+Defined in src/pools/abstract-pool.ts:596
Protected
Abstract
createWorker
@@ -487,7 +487,7 @@ Can be overridden.
Returns Worker
+Defined in src/pools/abstract-pool.ts:580
Private
dequeueTask
@@ -500,7 +500,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:756
+Defined in src/pools/abstract-pool.ts:415
Protected
Abstract
destroyWorker
@@ -528,7 +528,7 @@ Can be overridden.
Returns void | Promise<void>
+Defined in src/pools/abstract-pool.ts:430
+Defined in src/pools/abstract-pool.ts:325
Private
enqueueTask
@@ -565,7 +565,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:752
+Defined in src/pools/abstract-pool.ts:380
Private
executeTask
@@ -603,7 +603,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:747
Private
flushTasksQueue
@@ -616,7 +616,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:764
Private
flushTasksQueues
@@ -624,7 +624,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:775
Private
getWorkerNodeKey
@@ -642,7 +642,7 @@ Can be overridden.
Returns number
The worker node key if the worker is found in the pool worker nodes, -1
otherwise.
+Defined in src/pools/abstract-pool.ts:277
Protected
internalBusy
@@ -650,7 +650,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:371
Protected
Abstract
isMain
@@ -660,7 +660,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:445
Private
pushWorkerNode
@@ -678,7 +678,7 @@ Can be overridden.
Returns number
The worker nodes length.
+Defined in src/pools/abstract-pool.ts:693
Protected
Abstract
registerWorkerMessageListener
@@ -715,7 +715,7 @@ Can be overridden.
Returns void
Returns void
+Defined in src/pools/abstract-pool.ts:573
Private
removeWorkerNode
@@ -732,7 +732,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:739
Protected
Abstract
sendToWorker
@@ -753,7 +753,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:562
+Defined in src/pools/abstract-pool.ts:337
+Defined in src/pools/abstract-pool.ts:284
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:314
Private
setWorkerNode
@@ -840,7 +840,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:721
Private
setWorkerNodeTasksUsage
@@ -861,7 +861,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:680
Protected
setupHook
@@ -872,7 +872,7 @@ Can be overridden
Returns void
+Defined in src/pools/abstract-pool.ts:438
Private
tasksQueueSize
@@ -885,7 +885,7 @@ Can be overridden
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:760
Private
updateRunTimeTasksUsage
@@ -900,7 +900,7 @@ Can be overridden
message: MessageValue<Response, Worker | MessagePort>
Returns void
+Defined in src/pools/abstract-pool.ts:479
Private
updateWaitTimeTasksUsage
@@ -915,7 +915,7 @@ Can be overridden
message: MessageValue<Response, Worker | MessagePort>
Returns void
+Defined in src/pools/abstract-pool.ts:502
+Defined in src/pools/abstract-pool.ts:629
Path to the worker file.