X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=7806afafcb178b8bbc6d42415b006abc25d90b0a;hb=44b3657c414ad850ef46d6b7c13a48ab3130cb32;hp=e498d41b0f1f8d59f0b6943430e09fe606faadc6;hpb=aac8863d208eadcb0ecb33dc44d045c26f5a444f;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index e498d41b..7806afaf 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:45
+Defined in src/pools/abstract-pool.ts:85
Protected
Readonly
filePath
filePath: string
@@ -191,7 +193,7 @@
+Defined in src/pools/abstract-pool.ts:87
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -199,7 +201,7 @@
+Defined in src/pools/abstract-pool.ts:86
Protected
Readonly
opts
@@ -207,7 +209,7 @@
+Defined in src/pools/abstract-pool.ts:88
Protected
promiseResponseMap
@@ -220,7 +222,7 @@
+Defined in src/pools/abstract-pool.ts:64
Protected
workerChoiceStrategyContext
@@ -228,7 +230,7 @@
+Defined in src/pools/abstract-pool.ts:72
Readonly
workerNodes
@@ -237,7 +239,7 @@
+Defined in src/pools/abstract-pool.ts:51
Protected
full
@@ -263,7 +265,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:371
+Defined in src/pools/abstract-pool.ts:220
Protected
Abstract
maxSize
@@ -286,7 +288,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:288
Protected
Abstract
minSize
@@ -297,7 +299,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:283
Protected
Abstract
type
@@ -309,7 +311,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:273
Protected
Abstract
worker
@@ -320,7 +322,7 @@
Returns "cluster" | "thread"
+Defined in src/pools/abstract-pool.ts:278
Protected
Abstract
afterWorkerSetup
@@ -367,7 +369,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:677
Protected
beforeTaskExecutionHook
@@ -392,7 +394,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:470
Private
buildTasksQueueOptions
@@ -405,7 +407,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:358
Private
checkAndEmitEvents
@@ -413,7 +415,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:772
Private
checkFilePath
@@ -426,7 +428,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:122
Private
checkNumberOfWorkers
@@ -439,7 +441,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:131
Private
checkPoolOptions
@@ -452,7 +454,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:149
Private
checkValidTasksQueueOptions
@@ -465,7 +467,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:204
Private
checkValidWorkerChoiceStrategy
@@ -478,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:176
Private
checkValidWorkerChoiceStrategyOptions
@@ -491,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:621
+
+Protected
createAndSetupDynamicWorker
+
Protected
createAndSetupWorker
@@ -516,18 +530,19 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:684
Protected
Abstract
createWorker
- createWorker(): Worker
-
-
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:853
destroy
- destroy(): Promise<void>
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:861
Private
flushTasksQueues
@@ -673,7 +688,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:872
Private
getTaskStatistics
@@ -686,7 +701,7 @@ Can be overridden.
worker: Worker
+Defined in src/pools/abstract-pool.ts:923
Private
getWorkerNodeKey
@@ -706,7 +721,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:296
Private
getWorkerUsage
@@ -719,15 +734,19 @@ Can be overridden.
worker: Worker
+Defined in src/pools/abstract-pool.ts:890
Protected
internalBusy
- internalBusy(): boolean
-
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:387
Protected
Abstract
isMain
@@ -738,7 +757,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:461
Private
pushWorkerNode
@@ -758,7 +777,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:802
Protected
Abstract
registerWorkerMessageListener
@@ -798,7 +817,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:659
Private
removeWorkerNode
@@ -817,7 +836,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:836
Protected
Abstract
sendToWorker
@@ -841,7 +860,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:648
+Defined in src/pools/abstract-pool.ts:348
+Defined in src/pools/abstract-pool.ts:303
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:325
Private
setWorkerNodeTasksUsage
@@ -930,7 +949,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:789
Private
setWorkerStatistics
@@ -943,7 +962,7 @@ Can be overridden.
worker: Worker
Returns void
+Defined in src/pools/abstract-pool.ts:878
Protected
setupHook
@@ -955,7 +974,19 @@ Can be overridden
Returns void
+Defined in src/pools/abstract-pool.ts:454
+
+Private
shallCreateDynamicWorker
+
Private
tasksQueueSize
@@ -968,7 +999,7 @@ Can be overridden
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:857
Private
updateEluWorkerUsage
@@ -983,7 +1014,7 @@ Can be overridden
message: MessageValue<Response, unknown, Worker | MessagePort>
Returns void
+Defined in src/pools/abstract-pool.ts:569
Private
updateRunTimeWorkerUsage
@@ -998,7 +1029,7 @@ Can be overridden
message: MessageValue<Response, unknown, Worker | MessagePort>
Returns void
+Defined in src/pools/abstract-pool.ts:509
Private
updateTaskStatisticsWorkerUsage
@@ -1013,7 +1044,7 @@ Can be overridden
message: MessageValue<Response, unknown, Worker | MessagePort>
Returns void
+Defined in src/pools/abstract-pool.ts:497
Private
updateWaitTimeWorkerUsage
@@ -1028,7 +1059,7 @@ Can be overridden
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:538
Protected
workerListener
@@ -1055,7 +1086,7 @@ Can be overridden
+Defined in src/pools/abstract-pool.ts:741
Chooses a worker node for the next task.
-The default worker choice strategy uses a round robin algorithm to distribute the load.
+The default worker choice strategy uses a round robin algorithm to distribute the tasks.