X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=d100e14889ec71c12977e9f0c175905c3351b81a;hb=c0eb19668d003c60eb90781a1c91f2743442ed83;hp=bf67558965e87ec5bc4d2f7b7682f78b2cde7b5f;hpb=8d20e449d72975f6add9177d1097d5a204d14f71;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index bf675589..d100e148 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+Defined in src/pools/abstract-pool.ts:46
@@ -161,7 +167,7 @@
Returns AbstractPool<Worker, Data, Response>
+Defined in src/pools/abstract-pool.ts:86
Protected
Readonly
filePath
filePath: string
@@ -187,7 +193,7 @@
+Defined in src/pools/abstract-pool.ts:88
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -195,7 +201,7 @@
+Defined in src/pools/abstract-pool.ts:87
Protected
Readonly
opts
@@ -203,7 +209,7 @@
+Defined in src/pools/abstract-pool.ts:89
Protected
promiseResponseMap
@@ -216,16 +222,15 @@
+Defined in src/pools/abstract-pool.ts:65
Protected
workerChoiceStrategyContext
+Defined in src/pools/abstract-pool.ts:73
Readonly
workerNodes
@@ -234,7 +239,7 @@
+Defined in src/pools/abstract-pool.ts:52
Protected
full
@@ -260,7 +265,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:391
+Defined in src/pools/abstract-pool.ts:240
Protected
Abstract
maxSize
@@ -283,7 +288,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:308
Protected
Abstract
minSize
@@ -294,7 +299,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:303
Protected
Abstract
type
@@ -306,7 +311,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:293
Protected
Abstract
worker
@@ -317,7 +322,7 @@
Returns "cluster" | "thread"
+Defined in src/pools/abstract-pool.ts:298
Protected
Abstract
afterWorkerSetup
@@ -364,11 +369,11 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:696
Protected
beforeTaskExecutionHook
-- beforeTaskExecutionHook(workerNodeKey): void
+- beforeTaskExecutionHook(workerNodeKey, task): void
-
Returns void
+Defined in src/pools/abstract-pool.ts:489
Private
buildTasksQueueOptions
@@ -397,7 +407,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:378
Private
checkAndEmitEvents
@@ -405,7 +415,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:795
Private
checkFilePath
@@ -418,7 +428,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:123
Private
checkNumberOfWorkers
@@ -431,7 +441,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:132
Private
checkPoolOptions
@@ -444,7 +454,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:150
Private
checkValidTasksQueueOptions
@@ -457,7 +467,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:215
Private
checkValidWorkerChoiceStrategy
@@ -467,10 +477,10 @@ Can be overridden.
Parameters
-
-
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
+workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Returns void
+Defined in src/pools/abstract-pool.ts:177
Private
checkValidWorkerChoiceStrategyOptions
@@ -483,20 +493,32 @@ Can be overridden.
Returns void
-
-Protected
chooseWorkerNode
-
+
+Private
chooseWorkerNode
+
- chooseWorkerNode(): number
-
Returns number
The worker node key
+Defined in src/pools/abstract-pool.ts:640
+
+Protected
createAndSetupDynamicWorker
+
Protected
createAndSetupWorker
@@ -508,18 +530,19 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:703
Protected
Abstract
createWorker
- createWorker(): Worker
-
-
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:876
destroy
- destroy(): Promise<void>
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:884
Private
flushTasksQueues
@@ -665,7 +688,20 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:895
+
+Private
getTaskStatistics
+
Private
getWorkerNodeKey
@@ -685,15 +721,32 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:316
+
+Private
getWorkerUsage
+
Protected
internalBusy
- internalBusy(): boolean
-
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:407
Protected
Abstract
isMain
@@ -704,7 +757,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:480
Private
pushWorkerNode
@@ -724,7 +777,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:825
Protected
Abstract
registerWorkerMessageListener
@@ -759,12 +812,12 @@ Can be overridden.
Parameters
+message: MessageValue<Message, unknown, Worker | MessagePort>
Returns void
Returns void
+Defined in src/pools/abstract-pool.ts:678
Private
removeWorkerNode
@@ -783,7 +836,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:859
Protected
Abstract
sendToWorker
@@ -800,14 +853,14 @@ Can be overridden.
-
-
message: MessageValue<Data, Worker | MessagePort>
+message: MessageValue<Data, unknown, Worker | MessagePort>
Returns void
+Defined in src/pools/abstract-pool.ts:667
+Defined in src/pools/abstract-pool.ts:368
setWorkerChoiceStrategy
@@ -839,7 +892,7 @@ Can be overridden.
Parameters
+Defined in src/pools/abstract-pool.ts:323
setWorkerChoiceStrategyOptions
-
+
+Private
setWorkerNodeTasksUsage
-- setWorkerNode(workerNodeKey, worker, tasksUsage, tasksQueue): void
+- setWorkerNodeTasksUsage(workerNode, workerUsage): void
-
-
Returns void
-
+
+Private
updateTaskStatisticsWorkerUsage
-- updateWaitTimeTasksUsage(workerTasksUsage, message): void
+- updateTaskStatisticsWorkerUsage(workerUsage, message): void
-
+
message: MessageValue<Response, unknown, Worker | MessagePort>
+Returns void
+
+Private
updateWaitTimeWorkerUsage
+
+- updateWaitTimeWorkerUsage(workerUsage, task): void
+-
+
Returns void
+Defined in src/pools/abstract-pool.ts:557
Protected
workerListener
@@ -1006,13 +1080,13 @@ Can be overridden
Parameters
+message: MessageValue<Response, unknown, Worker | MessagePort>
Returns void
The listener function to execute when a message is received from a worker.
+Defined in src/pools/abstract-pool.ts:763
Worker choice strategy context referencing a worker choice algorithm implementation.
-Default to a round robin algorithm.