X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=05e604785c9503029d889ba9864e940526f06451;hb=3abeb14de6a5845deeb027ccc69c3feeec8f4a3a;hp=57f1a76caf28e9779e28909e01d7840216cd9b80;hpb=6be0ab6d5c78c8e91cc4668d3d03db95f15cbfab;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 57f1a76c..05e60478 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier
+AbstractPool | poolifier - v2.6.9
@@ -29,12 +29,12 @@
Data = unknown
-
Data = unknown
@@ -167,7 +176,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:96
Protected
Readonly
filePath
filePath: string
@@ -193,7 +202,7 @@
+
Defined in src/pools/abstract-pool.ts:98
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -201,7 +210,7 @@
+Defined in src/pools/abstract-pool.ts:97
Protected
Readonly
opts
@@ -209,7 +218,7 @@
+Defined in src/pools/abstract-pool.ts:99
Protected
promiseResponseMap
@@ -222,7 +231,15 @@
+Defined in src/pools/abstract-pool.ts:70
+
+Private
Readonly
startTimestamp
+startTimestamp: number
+
+
Protected
workerChoiceStrategyContext
@@ -230,7 +247,7 @@
+Defined in src/pools/abstract-pool.ts:78
Readonly
workerNodes
@@ -239,7 +256,7 @@
+Defined in src/pools/abstract-pool.ts:57
Protected
full
@@ -265,7 +282,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:521
+Defined in src/pools/abstract-pool.ts:252
Protected
Abstract
maxSize
@@ -288,7 +305,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:427
Protected
Abstract
minSize
@@ -299,7 +316,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:422
Protected
Abstract
type
@@ -311,7 +328,19 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:412
+
+Private
utilization
+
+- get utilization(): number
+-
+
+
Returns number
The pool utilization.
+
+
Protected
Abstract
worker
@@ -322,7 +351,7 @@
Returns "cluster" | "thread"
+Defined in src/pools/abstract-pool.ts:417
-Protected
Abstract
afterWorkerSetup
+Protected
afterWorkerSetup
- afterWorkerSetup(worker): void
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:135
Private
checkNumberOfWorkers
@@ -441,7 +470,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:144
Private
checkPoolOptions
@@ -454,7 +483,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:162
Private
checkValidTasksQueueOptions
@@ -467,7 +496,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:227
Private
checkValidWorkerChoiceStrategy
@@ -480,7 +509,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:189
Private
checkValidWorkerChoiceStrategyOptions
@@ -493,7 +522,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:199
Private
chooseWorkerNode
@@ -506,7 +535,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:811
Protected
createAndSetupDynamicWorker
@@ -518,7 +547,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:947
Protected
createAndSetupWorker
@@ -530,7 +559,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:879
Protected
Abstract
createWorker
@@ -542,7 +571,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:861
Private
dequeueTask
@@ -555,19 +584,19 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1141
destroy
- destroy(): Promise<void>
-
-
Returns number
+Defined in src/pools/abstract-pool.ts:1137
execute
@@ -639,7 +668,7 @@ Can be overridden.
-
Optional
data: Data
-
Returns void
+Defined in src/pools/abstract-pool.ts:1132
Private
flushTasksQueue
@@ -680,7 +709,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1153
Private
flushTasksQueues
@@ -688,20 +717,92 @@ Can be overridden.
-
Returns void
-
+
+Private
getInitialWorkerInfo
+Defined in src/pools/abstract-pool.ts:1223
+
+Private
getInitialWorkerUsage
+
+- getInitialWorkerUsage(worker?): WorkerUsage
+-
+
+
Parameters
+
+-
+
Optional
worker: Worker
+
+
+
+Private
getWorkerId
+
+- getWorkerId(worker): undefined | number
+-
+
+
+
Returns undefined | number
The worker id.
+
+
+
+Private
getWorkerInfo
+
+- getWorkerInfo(workerNodeKey): WorkerInfo
+-
+
+
+
Parameters
+
+-
+
workerNodeKey: number
+
+
+
+
Private
getWorkerNodeKey
@@ -717,24 +818,37 @@ 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.
-
+
+Private
handleTaskExecutionResponse
-- getWorkerUsage(worker): WorkerUsage
+- handleTaskExecutionResponse(message): void
-
-
+Returns void
+
+Private
handleWorkerStartedMessage
+
+- handleWorkerStartedMessage(message): void
+-
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:986
Protected
internalBusy
@@ -746,7 +860,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:537
Protected
Abstract
isMain
@@ -757,7 +871,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:616
Private
pushWorkerNode
@@ -777,10 +891,23 @@ Can be overridden.
-
-Protected
Abstract
registerWorkerMessageListener
-
+
+Private
redistributeQueuedTasks
+
+- redistributeQueuedTasks(worker): void
+-
+
+
Returns void
+
+Private
registerWorkerMessageListener
+
- registerWorkerMessageListener<Message>(worker, listener): void
-
+
message: MessageValue<Message, unknown>
Returns void
Returns void
+Defined in src/pools/abstract-pool.ts:849
Private
removeWorkerNode
@@ -836,7 +963,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1124
Protected
Abstract
sendToWorker
@@ -853,14 +980,14 @@ Can be overridden.
-
-
message: MessageValue<Data, unknown, Worker | MessagePort>
+
Returns void
+Defined in src/pools/abstract-pool.ts:838
+Defined in src/pools/abstract-pool.ts:498
+Defined in src/pools/abstract-pool.ts:453
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:475
Private
setWorkerNodeTasksUsage
@@ -949,7 +1076,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1045
Private
setWorkerStatistics
@@ -962,19 +1089,19 @@ Can be overridden.
worker: Worker
Returns void
+Defined in src/pools/abstract-pool.ts:1169
Protected
setupHook
- setupHook(): void
-
-
Returns number
+Defined in src/pools/abstract-pool.ts:1145
Private
updateEluWorkerUsage
@@ -1011,10 +1151,10 @@ Can be overridden
-
-
-
message: MessageValue<Response, unknown, Worker | MessagePort>
+message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:740
Private
updateRunTimeWorkerUsage
@@ -1026,10 +1166,10 @@ Can be overridden
-
-
-
message: MessageValue<Response, unknown, Worker | MessagePort>
+message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:664
Private
updateTaskStatisticsWorkerUsage
@@ -1041,10 +1181,10 @@ Can be overridden
-
-
-
message: MessageValue<Response, unknown, Worker | MessagePort>
+message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:651
Private
updateWaitTimeWorkerUsage
@@ -1059,7 +1199,7 @@ Can be overridden
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:702
Protected
workerListener
@@ -1080,13 +1220,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:974
+WorkerTypes
+availableParallelism
\ No newline at end of file
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