X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=2377e5ef16fdc1a416ee8a3b6d1c857875680190;hb=396360a789e4806699533ddf899c79dc2b7ae868;hp=b8c10f4344cd8d7e0011d7ab330ffab52294b0d2;hpb=fab6d3b5750d884b29e5e7057628a06d88d0df8a;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index b8c10f43..2377e5ef 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:33
@@ -150,7 +150,7 @@
Returns AbstractPool<Worker, Data, Response>
+Defined in src/pools/abstract-pool.ts:75
Readonly
filePath
filePath: string
+Defined in src/pools/abstract-pool.ts:77
Readonly
numberOfWorkers
numberOfWorkers: number
+Defined in src/pools/abstract-pool.ts:76
+Defined in src/pools/abstract-pool.ts:78
Protected
promiseResponseMap
@@ -198,7 +198,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:52
Protected
workerChoiceStrategyContext
@@ -206,7 +206,7 @@
Default to a round robin algorithm.
+Defined in src/pools/abstract-pool.ts:62
Readonly
workerNodes
@@ -214,7 +214,7 @@
+Defined in src/pools/abstract-pool.ts:39
Protected
Abstract
full
@@ -238,7 +238,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:289
Private
numberOfQueuedTasks
@@ -248,7 +248,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:195
Private
numberOfRunningTasks
@@ -258,7 +258,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:185
+Defined in src/pools/abstract-pool.ts:180
Protected
Abstract
afterWorkerSetup
@@ -312,7 +312,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:474
Protected
beforeTaskExecutionHook
@@ -330,7 +330,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:375
Private
buildTasksQueueOptions
@@ -343,7 +343,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:276
Private
checkAndEmitEvents
@@ -351,7 +351,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:532
Private
checkFilePath
@@ -364,7 +364,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:112
Private
checkNumberOfWorkers
@@ -377,7 +377,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:121
Private
checkPoolOptions
@@ -390,7 +390,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:139
Private
checkValidTasksQueueOptions
@@ -403,7 +403,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:167
Private
checkValidWorkerChoiceStrategy
@@ -416,7 +416,7 @@ Can be overridden.
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
Returns void
+Defined in src/pools/abstract-pool.ts:157
Protected
chooseWorkerNode
@@ -428,7 +428,7 @@ Can be overridden.
Returns [number, WorkerNode<Worker, Data>]
[worker node key, worker node].
+Defined in src/pools/abstract-pool.ts:419
Protected
createAndSetupWorker
@@ -439,7 +439,7 @@ Can be overridden.
Returns Worker
New, completely set up worker.
+Defined in src/pools/abstract-pool.ts:481
Protected
Abstract
createWorker
@@ -449,7 +449,7 @@ Can be overridden.
Returns Worker
+Defined in src/pools/abstract-pool.ts:465
Private
dequeueTask
@@ -462,7 +462,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:634
+Defined in src/pools/abstract-pool.ts:338
Protected
Abstract
destroyWorker
@@ -490,7 +490,7 @@ Can be overridden.
Returns void | Promise<void>
+Defined in src/pools/abstract-pool.ts:352
+Defined in src/pools/abstract-pool.ts:254
Private
enqueueTask
@@ -527,7 +527,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:630
+Defined in src/pools/abstract-pool.ts:307
Private
executeTask
@@ -561,7 +561,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:625
Private
flushTasksQueue
@@ -574,7 +574,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:642
Private
flushTasksQueueByWorker
@@ -587,7 +587,7 @@ Can be overridden.
worker: Worker
Returns void
+Defined in src/pools/abstract-pool.ts:650
Private
flushTasksQueues
@@ -595,7 +595,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:655
Private
getWorkerNodeKey
@@ -613,7 +613,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:211
Private
getWorkerTasksUsage
@@ -633,7 +633,7 @@ Can be overridden.
The worker tasks usage.
+Defined in src/pools/abstract-pool.ts:563
Protected
internalBusy
@@ -641,7 +641,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:298
Protected
Abstract
isMain
@@ -651,7 +651,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:367
Private
pushWorkerNode
@@ -669,7 +669,7 @@ Can be overridden.
Returns number
The worker nodes length.
+Defined in src/pools/abstract-pool.ts:577
Protected
Abstract
registerWorkerMessageListener
@@ -706,7 +706,7 @@ Can be overridden.
Returns void
Returns void
+Defined in src/pools/abstract-pool.ts:458
Private
removeWorkerNode
@@ -723,7 +723,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:619
Protected
Abstract
sendToWorker
@@ -744,7 +744,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:447
+Defined in src/pools/abstract-pool.ts:266
+Defined in src/pools/abstract-pool.ts:218
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:244
Private
setWorkerNode
@@ -831,7 +831,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:601
Private
setWorkerNodeTasksUsage
@@ -852,7 +852,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:549
Protected
setupHook
@@ -863,7 +863,7 @@ Can be overridden
Returns void
+Defined in src/pools/abstract-pool.ts:360
Private
tasksQueueSize
@@ -876,7 +876,7 @@ Can be overridden
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:638
+Defined in src/pools/abstract-pool.ts:504
Path to the worker file.