X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=c6bf43baf88ac70a2be1d8227bf86ad1f2d9a5f8;hb=6d6c7ed0c2c3c83cefae4d8cd5bc9393126bba70;hp=7806afafcb178b8bbc6d42415b006abc25d90b0a;hpb=aba8d9bd41f1bd46f3cc3863c0c2e74bdfacb7b6;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 7806afaf..c6bf43ba 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -29,12 +29,12 @@
Data = unknown
-
+Defined in src/pools/abstract-pool.ts:87
Protected
Readonly
opts
@@ -209,7 +209,7 @@
+Defined in src/pools/abstract-pool.ts:89
Protected
promiseResponseMap
@@ -222,7 +222,7 @@
+Defined in src/pools/abstract-pool.ts:65
Protected
workerChoiceStrategyContext
@@ -230,7 +230,7 @@
+Defined in src/pools/abstract-pool.ts:73
Readonly
workerNodes
@@ -239,7 +239,7 @@
+Defined in src/pools/abstract-pool.ts:52
Protected
full
@@ -265,7 +265,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:390
+Defined in src/pools/abstract-pool.ts:240
Protected
Abstract
maxSize
@@ -288,7 +288,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:307
Protected
Abstract
minSize
@@ -299,7 +299,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:302
Protected
Abstract
type
@@ -311,7 +311,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:292
Protected
Abstract
worker
@@ -322,7 +322,7 @@
Returns "cluster" | "thread"
+Defined in src/pools/abstract-pool.ts:297
-Protected
Abstract
afterWorkerSetup
+Protected
afterWorkerSetup
- afterWorkerSetup(worker): void
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:123
Private
checkNumberOfWorkers
@@ -441,7 +441,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:132
Private
checkPoolOptions
@@ -454,7 +454,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:150
Private
checkValidTasksQueueOptions
@@ -467,7 +467,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:215
Private
checkValidWorkerChoiceStrategy
@@ -480,7 +480,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:177
Private
checkValidWorkerChoiceStrategyOptions
@@ -493,7 +493,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:187
Private
chooseWorkerNode
@@ -506,7 +506,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:638
Protected
createAndSetupDynamicWorker
@@ -518,7 +518,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:739
Protected
createAndSetupWorker
@@ -530,7 +530,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:706
Protected
Abstract
createWorker
@@ -542,7 +542,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:688
Private
dequeueTask
@@ -555,7 +555,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:883
+Defined in src/pools/abstract-pool.ts:449
Protected
Abstract
destroyWorker
@@ -586,7 +586,7 @@ Can be overridden.
Returns void | Promise<void>
+Defined in src/pools/abstract-pool.ts:464
+Defined in src/pools/abstract-pool.ts:355
Private
enqueueTask
@@ -626,7 +626,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:879
execute
@@ -639,7 +639,7 @@ Can be overridden.
-
Optional
data: Data
-
Returns void
+Defined in src/pools/abstract-pool.ts:874
Private
flushTasksQueue
@@ -680,7 +680,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:895
Private
flushTasksQueues
@@ -688,20 +688,7 @@ Can be overridden.
-
Returns void
-
-Private
getTaskStatistics
-
+Defined in src/pools/abstract-pool.ts:907
Private
getWorkerNodeKey
@@ -717,24 +704,24 @@ 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:315
Private
getWorkerUsage
-- getWorkerUsage(worker): WorkerUsage
+- getWorkerUsage(workerNodeKey?): WorkerUsage
-
+
Optional
workerNodeKey: number
+Defined in src/pools/abstract-pool.ts:925
Protected
internalBusy
@@ -746,7 +733,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:406
Protected
Abstract
isMain
@@ -757,7 +744,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:479
Private
pushWorkerNode
@@ -777,10 +764,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:676
Private
removeWorkerNode
@@ -836,7 +823,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:866
Protected
Abstract
sendToWorker
@@ -853,14 +840,14 @@ Can be overridden.
-
-
message: MessageValue<Data, unknown, Worker | MessagePort>
+
Returns void
+Defined in src/pools/abstract-pool.ts:665
+Defined in src/pools/abstract-pool.ts:367
+Defined in src/pools/abstract-pool.ts:322
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:344
Private
setWorkerNodeTasksUsage
@@ -949,7 +936,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:813
Private
setWorkerStatistics
@@ -962,19 +949,19 @@ Can be overridden.
worker: Worker
Returns void
+Defined in src/pools/abstract-pool.ts:913
Protected
setupHook
- setupHook(): void
-
-
Returns number
+Defined in src/pools/abstract-pool.ts:887
Private
updateEluWorkerUsage
@@ -1011,10 +1011,10 @@ Can be overridden
-
-
-
message: MessageValue<Response, unknown, Worker | MessagePort>
+message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:586
Private
updateRunTimeWorkerUsage
@@ -1026,10 +1026,10 @@ Can be overridden
-
-
-
message: MessageValue<Response, unknown, Worker | MessagePort>
+message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:526
Private
updateTaskStatisticsWorkerUsage
@@ -1041,10 +1041,10 @@ Can be overridden
-
-
-
message: MessageValue<Response, unknown, Worker | MessagePort>
+message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:514
Private
updateWaitTimeWorkerUsage
@@ -1059,7 +1059,7 @@ Can be overridden
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:555
Protected
workerListener
@@ -1080,13 +1080,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:764
+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.
@@ -105,13 +105,12 @@ execute Task
flush Tasks Queue
flush Tasks Queues
-get Task Statistics
get Worker Node Key
get Worker Usage
internal Busy
is Main
push Worker Node
-register Worker Message Listener
+register Worker Message Listener
remove Worker Node
send To Worker
set Tasks Queue Options
@@ -121,6 +120,7 @@
set Worker Statistics
setup Hook
shall Create Dynamic Worker
+tasks Max Queue Size
tasks Queue Size
update Elu Worker Usage
update Run Time Worker Usage
@@ -141,7 +141,7 @@
-
-
+-
-
@@ -167,7 +167,7 @@
Type Parameters
Worker extends IWorker<Worker>
Worker extends IWorker
Data = unknown
Returns AbstractPool<Worker, Data, Response>
Properties
Protected
Readonly
fileProtected
Readonly
number