X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FAbstractPool.html;h=0fbaae35c5292e27c894015d86e3dca4f3c753e8;hb=1ab50fe5ad0b27a13a48047f9414d4138d43a5cd;hp=df41d32e1ed196c8493a9e4b8c3805233829cecc;hpb=1e8c193fa4e519921b6db1b0d9d443cb15ecf12a;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index df41d32e..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
@@ -150,7 +153,7 @@
Returns AbstractPool<Worker, Data, Response>
+Defined in src/pools/abstract-pool.ts:80
Properties
@@ -161,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
@@ -198,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
@@ -206,7 +211,7 @@
Default to a round robin algorithm.
+Defined in src/pools/abstract-pool.ts:67
Readonly
workerNodes
@@ -214,7 +219,7 @@
+Defined in src/pools/abstract-pool.ts:44
-Protected
Abstract
full
+Protected
full
- get full(): boolean
-
@@ -238,39 +243,59 @@
Returns boolean
-
-Private
numberOfQueuedTasks
-
+
+
+Protected
Abstract
maxSize
+
Returns void
+Defined in src/pools/abstract-pool.ts:589
Protected
beforeTaskExecutionHook
@@ -330,7 +355,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:453
Private
buildTasksQueueOptions
@@ -343,7 +368,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:347
Private
checkAndEmitEvents
@@ -351,7 +376,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:663
Private
checkFilePath
@@ -364,7 +389,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:117
Private
checkNumberOfWorkers
@@ -377,7 +402,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:126
Private
checkPoolOptions
@@ -390,7 +415,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:144
Private
checkValidTasksQueueOptions
@@ -403,7 +428,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:199
Private
checkValidWorkerChoiceStrategy
@@ -413,22 +438,35 @@ Can be overridden.
Parameters
-
-
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
+Returns void
+
+Private
checkValidWorkerChoiceStrategyOptions
+
+- checkValidWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void
+-
+
Returns void
+Defined in src/pools/abstract-pool.ts:181
Protected
chooseWorkerNode
+Defined in src/pools/abstract-pool.ts:532
Protected
createAndSetupWorker
@@ -439,7 +477,7 @@ Can be overridden.
Returns Worker
New, completely set up worker.
+Defined in src/pools/abstract-pool.ts:596
Protected
Abstract
createWorker
@@ -449,7 +487,7 @@ Can be overridden.
Returns Worker
+Defined in src/pools/abstract-pool.ts:580
Private
dequeueTask
@@ -462,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
@@ -490,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
@@ -527,13 +565,13 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:752
execute
-- execute(data?): Promise<Response>
+- execute(data?, name?): Promise<Response>
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:747
Private
flushTasksQueue
@@ -574,20 +616,7 @@ Can be overridden.
workerNodeKey: number
Returns void
-
-Private
flushTasksQueueByWorker
-
-- flushTasksQueueByWorker(worker): void
--
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:764
Private
flushTasksQueues
@@ -595,7 +624,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:775
Private
getWorkerNodeKey
@@ -613,27 +642,7 @@ Can be overridden.
Returns number
The worker node key if the worker is found in the pool worker nodes, -1
otherwise.
-
-Private
getWorkerTasksUsage
-
-- getWorkerTasksUsage(worker): TasksUsage
--
-
-
-
The worker tasks usage.
-
+Defined in src/pools/abstract-pool.ts:277
Protected
internalBusy
@@ -641,7 +650,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:371
Protected
Abstract
isMain
@@ -651,7 +660,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:445
Private
pushWorkerNode
@@ -669,7 +678,7 @@ Can be overridden.
Returns number
The worker nodes length.
+Defined in src/pools/abstract-pool.ts:693
Protected
Abstract
registerWorkerMessageListener
@@ -702,11 +711,11 @@ Can be overridden.
Parameters
+message: MessageValue<Message, Worker | MessagePort>
Returns void
Returns void
+Defined in src/pools/abstract-pool.ts:573
Private
removeWorkerNode
@@ -723,7 +732,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:739
Protected
Abstract
sendToWorker
@@ -739,12 +748,12 @@ Can be overridden.
-
-
+
message: MessageValue<Data, Worker | MessagePort>
Returns void
+Defined in src/pools/abstract-pool.ts:562
+Defined in src/pools/abstract-pool.ts:337
setWorkerChoiceStrategy
@@ -774,7 +783,7 @@ Can be overridden.
Parameters
-
-
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
-
@@ -784,7 +793,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:284
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:314
Private
setWorkerNode
@@ -831,7 +840,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:721
Private
setWorkerNodeTasksUsage
@@ -852,7 +861,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:680
Protected
setupHook
@@ -863,7 +872,7 @@ Can be overridden
Returns void
+Defined in src/pools/abstract-pool.ts:438
Private
tasksQueueSize
@@ -876,7 +885,37 @@ Can be overridden
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:760
+
+Private
updateRunTimeTasksUsage
+
+- updateRunTimeTasksUsage(workerTasksUsage, message): void
+-
+
+
Parameters
+
+-
+
+-
+
message: MessageValue<Response, Worker | MessagePort>
+Returns void
+
+Private
updateWaitTimeTasksUsage
+
+- updateWaitTimeTasksUsage(workerTasksUsage, message): void
+-
+
+
Parameters
+
+-
+
+-
+
message: MessageValue<Response, Worker | MessagePort>
+Returns void
Protected
workerListener
@@ -897,11 +936,11 @@ Can be overridden
Parameters
+message: MessageValue<Response, Worker | MessagePort>
Returns void
The listener function to execute when a message is received from a worker.
+Defined in src/pools/abstract-pool.ts:629
+PoolTypes
+WorkerChoiceStrategies
+WorkerTypes
Path to the worker file.