X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=b283abbbed56bc86fd81e54e0da42e5c76db5944;hb=184d530faf6acf70e116cb4a3fb831938b73e2c0;hp=bbb0411cfc7d34ca0df13f48a05e18118c24dd02;hpb=811dc01fd8bb1b23cc3e6e72f7fbc82cc8f473ae;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index bbb0411c..b283abbb 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
Properties
@@ -163,32 +164,34 @@
'full'
: Emitted when the pool is dynamic and full.
'busy'
: Emitted when the pool is busy.
+'error'
: Emitted when an uncaught error occurs.
+'taskError'
: Emitted when an error occurs while executing a task.
-
+
+Protected
Readonly
filePath
filePath: string
-
+
+Protected
Readonly
numberOfWorkers
numberOfWorkers: number
-
+
+Defined in src/pools/abstract-pool.ts:83
Protected
promiseResponseMap
@@ -200,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
@@ -208,7 +211,7 @@
Default to a round robin algorithm.
+Defined in src/pools/abstract-pool.ts:67
Readonly
workerNodes
@@ -216,7 +219,7 @@
+Defined in src/pools/abstract-pool.ts:44
-Protected
Abstract
full
+Protected
full
- get full(): boolean
-
@@ -240,50 +243,59 @@
Returns boolean
-
-Private
numberOfQueuedTasks
-
+
+Defined in src/pools/abstract-pool.ts:589
Protected
beforeTaskExecutionHook
@@ -343,7 +355,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:453
Private
buildTasksQueueOptions
@@ -356,7 +368,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:347
Private
checkAndEmitEvents
@@ -364,7 +376,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:663
Private
checkFilePath
@@ -377,7 +389,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:117
Private
checkNumberOfWorkers
@@ -390,7 +402,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:126
Private
checkPoolOptions
@@ -403,7 +415,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:144
Private
checkValidTasksQueueOptions
@@ -416,7 +428,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:199
Private
checkValidWorkerChoiceStrategy
@@ -429,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
@@ -442,7 +454,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:181
Protected
chooseWorkerNode
@@ -454,7 +466,7 @@ Can be overridden.
Returns number
The worker node key
+Defined in src/pools/abstract-pool.ts:532
Protected
createAndSetupWorker
@@ -465,7 +477,7 @@ Can be overridden.
Returns Worker
New, completely set up worker.
+Defined in src/pools/abstract-pool.ts:596
Protected
Abstract
createWorker
@@ -475,7 +487,7 @@ Can be overridden.
Returns Worker
+Defined in src/pools/abstract-pool.ts:580
Private
dequeueTask
@@ -488,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
@@ -516,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
@@ -553,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
@@ -591,7 +603,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:747
Private
flushTasksQueue
@@ -604,7 +616,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:764
Private
flushTasksQueues
@@ -612,7 +624,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:775
Private
getWorkerNodeKey
@@ -630,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
@@ -638,7 +650,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:371
Protected
Abstract
isMain
@@ -648,7 +660,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:445
Private
pushWorkerNode
@@ -666,7 +678,7 @@ Can be overridden.
Returns number
The worker nodes length.
+Defined in src/pools/abstract-pool.ts:693
Protected
Abstract
registerWorkerMessageListener
@@ -703,7 +715,7 @@ Can be overridden.
Returns void
Returns void
+Defined in src/pools/abstract-pool.ts:573
Private
removeWorkerNode
@@ -720,7 +732,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:739
Protected
Abstract
sendToWorker
@@ -741,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
@@ -828,7 +840,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:721
Private
setWorkerNodeTasksUsage
@@ -849,7 +861,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:680
Protected
setupHook
@@ -860,7 +872,7 @@ Can be overridden
Returns void
+Defined in src/pools/abstract-pool.ts:438
Private
tasksQueueSize
@@ -873,7 +885,7 @@ Can be overridden
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:760
Private
updateRunTimeTasksUsage
@@ -888,7 +900,7 @@ Can be overridden
message: MessageValue<Response, Worker | MessagePort>
Returns void
+Defined in src/pools/abstract-pool.ts:479
Private
updateWaitTimeTasksUsage
@@ -903,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.