X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=c0dd907c55e061a9ad2b3d73a5f83916170465a9;hb=86f5c6c11d0a262b6514b95928b2534eecc37a4e;hp=2377e5ef16fdc1a416ee8a3b6d1c857875680190;hpb=4d8bf9e40e07bd233be4494fda4e4270fdd8a355;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 2377e5ef..c0dd907c 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:34
@@ -150,7 +150,7 @@
Returns AbstractPool<Worker, Data, Response>
+Defined in src/pools/abstract-pool.ts:76
Readonly
filePath
filePath: string
+Defined in src/pools/abstract-pool.ts:78
Readonly
numberOfWorkers
numberOfWorkers: number
+Defined in src/pools/abstract-pool.ts:77
+Defined in src/pools/abstract-pool.ts:79
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:53
Protected
workerChoiceStrategyContext
@@ -206,7 +206,7 @@
Default to a round robin algorithm.
+Defined in src/pools/abstract-pool.ts:63
Readonly
workerNodes
@@ -214,7 +214,7 @@
+Defined in src/pools/abstract-pool.ts:40
Protected
Abstract
full
@@ -238,7 +238,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:290
Private
numberOfQueuedTasks
@@ -248,7 +248,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:196
Private
numberOfRunningTasks
@@ -258,7 +258,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:186
+Defined in src/pools/abstract-pool.ts:181
Protected
Abstract
afterWorkerSetup
@@ -312,7 +312,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:475
Protected
beforeTaskExecutionHook
@@ -330,7 +330,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:376
Private
buildTasksQueueOptions
@@ -343,7 +343,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:277
Private
checkAndEmitEvents
@@ -351,7 +351,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:533
Private
checkFilePath
@@ -364,7 +364,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:113
Private
checkNumberOfWorkers
@@ -377,7 +377,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:122
Private
checkPoolOptions
@@ -390,7 +390,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:140
Private
checkValidTasksQueueOptions
@@ -403,7 +403,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:168
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:158
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:420
Protected
createAndSetupWorker
@@ -439,7 +439,7 @@ Can be overridden.
Returns Worker
New, completely set up worker.
+Defined in src/pools/abstract-pool.ts:482
Protected
Abstract
createWorker
@@ -449,7 +449,7 @@ Can be overridden.
Returns Worker
+Defined in src/pools/abstract-pool.ts:466
Private
dequeueTask
@@ -462,7 +462,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:635
+Defined in src/pools/abstract-pool.ts:339
Protected
Abstract
destroyWorker
@@ -490,7 +490,7 @@ Can be overridden.
Returns void | Promise<void>
+Defined in src/pools/abstract-pool.ts:353
+Defined in src/pools/abstract-pool.ts:255
Private
enqueueTask
@@ -527,7 +527,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:631
+Defined in src/pools/abstract-pool.ts:308
Private
executeTask
@@ -561,7 +561,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:626
Private
flushTasksQueue
@@ -574,7 +574,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:643
Private
flushTasksQueueByWorker
@@ -587,7 +587,7 @@ Can be overridden.
worker: Worker
Returns void
+Defined in src/pools/abstract-pool.ts:654
Private
flushTasksQueues
@@ -595,7 +595,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:659
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:212
Private
getWorkerTasksUsage
@@ -633,7 +633,7 @@ Can be overridden.
The worker tasks usage.
+Defined in src/pools/abstract-pool.ts:564
Protected
internalBusy
@@ -641,7 +641,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:299
Protected
Abstract
isMain
@@ -651,7 +651,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:368
Private
pushWorkerNode
@@ -669,7 +669,7 @@ Can be overridden.
Returns number
The worker nodes length.
+Defined in src/pools/abstract-pool.ts:578
Protected
Abstract
registerWorkerMessageListener
@@ -706,7 +706,7 @@ Can be overridden.
Returns void
Returns void
+Defined in src/pools/abstract-pool.ts:459
Private
removeWorkerNode
@@ -723,7 +723,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:620
Protected
Abstract
sendToWorker
@@ -744,7 +744,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:448
+Defined in src/pools/abstract-pool.ts:267
+Defined in src/pools/abstract-pool.ts:219
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:245
Private
setWorkerNode
@@ -826,12 +826,12 @@ Can be overridden.
-
-
tasksQueue: Task<Data>[]
+tasksQueue: Queue<Task<Data>>
Returns void
+Defined in src/pools/abstract-pool.ts:602
Private
setWorkerNodeTasksUsage
@@ -852,7 +852,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:550
Protected
setupHook
@@ -863,7 +863,7 @@ Can be overridden
Returns void
+Defined in src/pools/abstract-pool.ts:361
Private
tasksQueueSize
@@ -876,7 +876,7 @@ Can be overridden
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:639
+Defined in src/pools/abstract-pool.ts:505
Path to the worker file.