X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=c67d842f1d422de5b07647acb15ad441ecc3dcb8;hb=ccb7d1a70cd9bd4eb050160517e5bc48311d014f;hp=df41d32e1ed196c8493a9e4b8c3805233829cecc;hpb=3dd69d8ee8aa2132fccb106720a9f5ae67b92cc8;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index df41d32e..c67d842f 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:35
@@ -150,7 +152,7 @@
Returns AbstractPool<Worker, Data, Response>
+Defined in src/pools/abstract-pool.ts:77
Properties
@@ -161,32 +163,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.
+Defined in src/pools/abstract-pool.ts:44
Readonly
filePath
filePath: string
+Defined in src/pools/abstract-pool.ts:79
Readonly
numberOfWorkers
numberOfWorkers: number
+Defined in src/pools/abstract-pool.ts:78
+Defined in src/pools/abstract-pool.ts:80
Protected
promiseResponseMap
@@ -198,7 +202,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:54
Protected
workerChoiceStrategyContext
@@ -206,7 +210,7 @@
Default to a round robin algorithm.
+Defined in src/pools/abstract-pool.ts:64
Readonly
workerNodes
@@ -214,7 +218,7 @@
+Defined in src/pools/abstract-pool.ts:41
Protected
Abstract
full
@@ -238,7 +242,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:329
Private
numberOfQueuedTasks
@@ -248,7 +252,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:230
Private
numberOfRunningTasks
@@ -258,7 +262,18 @@
Returns number
+Defined in src/pools/abstract-pool.ts:220
+
+Abstract
size
+
+- get size(): number
+-
+
+
Returns number
+Defined in src/pools/abstract-pool.ts:212
Protected
Abstract
afterWorkerSetup
@@ -312,7 +327,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:554
Protected
beforeTaskExecutionHook
@@ -330,7 +345,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:419
Private
buildTasksQueueOptions
@@ -343,7 +358,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:316
Private
checkAndEmitEvents
@@ -351,7 +366,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:628
Private
checkFilePath
@@ -364,7 +379,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:114
Private
checkNumberOfWorkers
@@ -377,7 +392,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:123
Private
checkPoolOptions
@@ -390,7 +405,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:141
Private
checkValidTasksQueueOptions
@@ -403,7 +418,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:196
Private
checkValidWorkerChoiceStrategy
@@ -413,22 +428,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:178
Protected
chooseWorkerNode
+Defined in src/pools/abstract-pool.ts:498
Protected
createAndSetupWorker
@@ -439,7 +467,7 @@ Can be overridden.
Returns Worker
New, completely set up worker.
+Defined in src/pools/abstract-pool.ts:561
Protected
Abstract
createWorker
@@ -449,7 +477,7 @@ Can be overridden.
Returns Worker
+Defined in src/pools/abstract-pool.ts:545
Private
dequeueTask
@@ -462,7 +490,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:727
+Defined in src/pools/abstract-pool.ts:382
Protected
Abstract
destroyWorker
@@ -490,7 +518,7 @@ Can be overridden.
Returns void | Promise<void>
+Defined in src/pools/abstract-pool.ts:396
+Defined in src/pools/abstract-pool.ts:294
Private
enqueueTask
@@ -527,13 +555,13 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:723
execute
-- execute(data?): Promise<Response>
+- execute(data?, name?): Promise<Response>
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:718
Private
flushTasksQueue
@@ -574,20 +606,7 @@ Can be overridden.
workerNodeKey: number
Returns void
-
-Private
flushTasksQueueByWorker
-
-- flushTasksQueueByWorker(worker): void
--
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:735
Private
flushTasksQueues
@@ -595,7 +614,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:746
Private
getWorkerNodeKey
@@ -613,27 +632,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:246
Protected
internalBusy
@@ -641,7 +640,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:338
Protected
Abstract
isMain
@@ -651,7 +650,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:411
Private
pushWorkerNode
@@ -669,7 +668,7 @@ Can be overridden.
Returns number
The worker nodes length.
+Defined in src/pools/abstract-pool.ts:664
Protected
Abstract
registerWorkerMessageListener
@@ -702,11 +701,11 @@ Can be overridden.
Parameters
+message: MessageValue<Message, Worker | MessagePort>
Returns void
Returns void
+Defined in src/pools/abstract-pool.ts:538
Private
removeWorkerNode
@@ -723,7 +722,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:710
Protected
Abstract
sendToWorker
@@ -739,12 +738,12 @@ Can be overridden.
-
-
+
message: MessageValue<Data, Worker | MessagePort>
Returns void
+Defined in src/pools/abstract-pool.ts:527
+Defined in src/pools/abstract-pool.ts:306
setWorkerChoiceStrategy
@@ -774,7 +773,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 +783,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:253
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:283
Private
setWorkerNode
@@ -831,7 +830,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:692
Private
setWorkerNodeTasksUsage
@@ -852,7 +851,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:651
Protected
setupHook
@@ -863,7 +862,7 @@ Can be overridden
Returns void
+Defined in src/pools/abstract-pool.ts:404
Private
tasksQueueSize
@@ -876,7 +875,37 @@ Can be overridden
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:731
+
+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 +926,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:594
Path to the worker file.