X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=e8cc3a662e487f686efd3050b14055fb144b025a;hb=2624da4d8f724e8bc0b655cddfc6ba5ae9a4d053;hp=7806afafcb178b8bbc6d42415b006abc25d90b0a;hpb=aba8d9bd41f1bd46f3cc3863c0c2e74bdfacb7b6;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 7806afaf..e8cc3a66 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -29,12 +29,12 @@
Data = unknown
-
Data = unknown
@@ -167,7 +174,7 @@
Returns AbstractPool<Worker, Data, Response>
+Defined in src/pools/abstract-pool.ts:94
Protected
Readonly
filePath
filePath: string
@@ -193,7 +200,7 @@
+Defined in src/pools/abstract-pool.ts:96
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -201,7 +208,7 @@
+Defined in src/pools/abstract-pool.ts:95
Protected
Readonly
opts
@@ -209,7 +216,7 @@
+Defined in src/pools/abstract-pool.ts:97
Protected
promiseResponseMap
@@ -222,7 +229,15 @@
+Defined in src/pools/abstract-pool.ts:68
+
+Private
Readonly
startTimestamp
+startTimestamp: number
+
+
Protected
workerChoiceStrategyContext
@@ -230,7 +245,7 @@
+Defined in src/pools/abstract-pool.ts:76
Readonly
workerNodes
@@ -239,7 +254,7 @@
+Defined in src/pools/abstract-pool.ts:55
Protected
full
@@ -265,7 +280,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:444
+Defined in src/pools/abstract-pool.ts:250
Protected
Abstract
maxSize
@@ -288,7 +303,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:350
Protected
Abstract
minSize
@@ -299,7 +314,19 @@
Returns number
+Defined in src/pools/abstract-pool.ts:345
+
Protected
Abstract
type
@@ -311,7 +338,19 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:335
+
+Private
utilization
+
+- get utilization(): number
+-
+
+
Returns number
The pool utilization.
+
+
Protected
Abstract
worker
@@ -322,7 +361,7 @@
Returns "cluster" | "thread"
+Defined in src/pools/abstract-pool.ts:340
-Protected
Abstract
afterWorkerSetup
+Protected
afterWorkerSetup
- afterWorkerSetup(worker): void
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:133
Private
checkNumberOfWorkers
@@ -441,7 +480,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:142
Private
checkPoolOptions
@@ -454,7 +493,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:160
Private
checkValidTasksQueueOptions
@@ -467,7 +506,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:225
Private
checkValidWorkerChoiceStrategy
@@ -480,7 +519,7 @@ Can be overridden.
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:187
Private
checkValidWorkerChoiceStrategyOptions
@@ -493,7 +532,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:197
Private
chooseWorkerNode
@@ -506,7 +545,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:692
Protected
createAndSetupDynamicWorker
@@ -518,7 +557,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:793
Protected
createAndSetupWorker
@@ -530,7 +569,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:760
Protected
Abstract
createWorker
@@ -542,7 +581,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:742
Private
dequeueTask
@@ -555,19 +594,19 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:977
destroy
- destroy(): Promise<void>
-
-
Returns number
+Defined in src/pools/abstract-pool.ts:973
execute
@@ -639,7 +678,7 @@ Can be overridden.
-
Optional
data: Data
-
Returns void
+Defined in src/pools/abstract-pool.ts:968
Private
flushTasksQueue
@@ -680,7 +719,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:989
Private
flushTasksQueues
@@ -688,20 +727,47 @@ Can be overridden.
-
Returns void
-
+
+Private
getWorkerById
-- getTaskStatistics(worker): TaskStatistics
+- getWorkerById(workerId): undefined | Worker
-
+
-
+Returns undefined | Worker
The worker if found in the pool worker nodes, undefined
otherwise.
+
+
+Defined in src/pools/abstract-pool.ts:358
+
+Private
getWorkerId
+
+- getWorkerId(worker): undefined | number
+-
+
+
+
Returns undefined | number
The worker id.
+
+
Private
getWorkerNodeKey
@@ -717,24 +783,50 @@ Can be overridden.
-Returns number
The worker node key if the worker is found in the pool worker nodes, -1
otherwise.
+Returns number
The worker node key if found in the pool worker nodes, -1
otherwise.
+Defined in src/pools/abstract-pool.ts:369
Private
getWorkerUsage
-- getWorkerUsage(worker): WorkerUsage
+- getWorkerUsage(workerNodeKey?): WorkerUsage
-
+
Optional
workerNodeKey: number
+Defined in src/pools/abstract-pool.ts:1019
+
+Private
handleTaskExecutionResponse
+
+- handleTaskExecutionResponse(message): void
+-
+
+
Returns void
+
+Private
handleWorkerStartedMessage
+
+- handleWorkerStartedMessage(message): void
+-
+
+
Returns void
Protected
internalBusy
@@ -746,7 +838,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:460
Protected
Abstract
isMain
@@ -757,7 +849,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:533
Private
pushWorkerNode
@@ -777,10 +869,10 @@ Can be overridden.
-
-Protected
Abstract
registerWorkerMessageListener
-
+
+Private
registerWorkerMessageListener
+
- registerWorkerMessageListener<Message>(worker, listener): void
-
+
message: MessageValue<Message, unknown>
Returns void
Returns void
+Defined in src/pools/abstract-pool.ts:730
Private
removeWorkerNode
@@ -836,7 +928,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:960
Protected
Abstract
sendToWorker
@@ -853,14 +945,14 @@ Can be overridden.
-
-
message: MessageValue<Data, unknown, Worker | MessagePort>
+
Returns void
+Defined in src/pools/abstract-pool.ts:719
+Defined in src/pools/abstract-pool.ts:421
+Defined in src/pools/abstract-pool.ts:376
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:398
Private
setWorkerNodeTasksUsage
@@ -949,7 +1041,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:889
Private
setWorkerStatistics
@@ -962,19 +1054,19 @@ Can be overridden.
worker: Worker
Returns void
+Defined in src/pools/abstract-pool.ts:1007
Protected
setupHook
- setupHook(): void
-
-
Returns number
+Defined in src/pools/abstract-pool.ts:981
Private
updateEluWorkerUsage
@@ -1011,10 +1116,10 @@ Can be overridden
-
-
-
message: MessageValue<Response, unknown, Worker | MessagePort>
+message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:640
Private
updateRunTimeWorkerUsage
@@ -1026,10 +1131,10 @@ Can be overridden
-
-
-
message: MessageValue<Response, unknown, Worker | MessagePort>
+message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:580
Private
updateTaskStatisticsWorkerUsage
@@ -1041,10 +1146,10 @@ Can be overridden
-
-
-
message: MessageValue<Response, unknown, Worker | MessagePort>
+message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:568
Private
updateWaitTimeWorkerUsage
@@ -1059,7 +1164,7 @@ Can be overridden
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:609
Protected
workerListener
@@ -1080,13 +1185,13 @@ Can be overridden
Parameters
-
-
message: MessageValue<Response, unknown, Worker | MessagePort>
+message: MessageValue<Response, unknown>
Returns void
The listener function to execute when a message is received from a worker.
+Defined in src/pools/abstract-pool.ts:818
+WorkerTypes
+availableParallelism
Type of data sent to the worker. This can only be serializable data.
+Type of data sent to the worker. This can only be structured-cloneable data.
Response = unknown
-Type of execution response. This can only be serializable data.
+Type of execution response. This can only be structured-cloneable data.
@@ -66,6 +66,7 @@ number Of Workers
opts
promise Response Map
+start Timestamp
worker Choice Strategy Context
worker Nodes