X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=984c1c21c2da8ba185da4297fe494a7610100b85;hb=5c30b9d94384214b24f11ea7e68a54efaa6795b7;hp=800d4a3cda8c167931058f5b209aa9f93238ebb6;hpb=222387cba569774821d225147ac6f35f4f1bc696;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 800d4a3c..984c1c21 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.17
+AbstractPool | poolifier - v2.6.19
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:55
+
Defined in src/pools/abstract-pool.ts:104
Protected
Readonly
filePath
filePath: string
@@ -204,7 +205,7 @@
+
Defined in src/pools/abstract-pool.ts:106
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -212,7 +213,7 @@
+Defined in src/pools/abstract-pool.ts:105
Protected
Readonly
opts
@@ -220,7 +221,7 @@
+Defined in src/pools/abstract-pool.ts:107
Protected
promiseResponseMap
@@ -233,7 +234,7 @@
+Defined in src/pools/abstract-pool.ts:74
Private
Readonly
startTimestamp
startTimestamp: number
@@ -241,7 +242,7 @@
+Defined in src/pools/abstract-pool.ts:95
Private
Readonly
starting
starting: boolean
@@ -249,7 +250,7 @@
+Defined in src/pools/abstract-pool.ts:91
Protected
workerChoiceStrategyContext
@@ -257,7 +258,7 @@
+Defined in src/pools/abstract-pool.ts:82
Readonly
workerNodes
@@ -266,7 +267,7 @@
+Defined in src/pools/abstract-pool.ts:61
Protected
full
@@ -292,7 +293,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:591
+Defined in src/pools/abstract-pool.ts:294
Protected
Abstract
maxSize
@@ -315,7 +316,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:483
Protected
Abstract
minSize
@@ -326,7 +327,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:478
Private
ready
@@ -334,7 +335,7 @@
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:430
Protected
Abstract
type
@@ -346,7 +347,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:468
+Defined in src/pools/abstract-pool.ts:447
Protected
Abstract
worker
@@ -369,7 +370,7 @@
Returns "cluster" | "thread"
+Defined in src/pools/abstract-pool.ts:473
Protected
afterTaskExecutionHook
@@ -416,7 +417,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:717
Protected
afterWorkerSetup
@@ -436,7 +437,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:941
Protected
beforeTaskExecutionHook
@@ -461,7 +462,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:696
Private
buildTasksQueueOptions
@@ -474,7 +475,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:578
Private
checkAndEmitEvents
@@ -482,7 +483,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1039
Protected
checkDynamicPoolSize
@@ -497,7 +498,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:174
Private
checkFilePath
@@ -510,7 +511,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:143
Private
checkMessageWorkerId
+Defined in src/pools/abstract-pool.ts:502
Private
checkNumberOfWorkers
@@ -544,7 +545,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:156
Private
checkPoolOptions
@@ -557,7 +558,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:192
Private
checkValidTasksQueueOptions
@@ -570,7 +571,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:257
Private
checkValidWorkerChoiceStrategy
@@ -583,7 +584,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:219
Private
checkValidWorkerChoiceStrategyOptions
@@ -596,7 +597,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:229
Private
chooseWorkerNode
@@ -609,7 +610,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:812
Protected
createAndSetupDynamicWorker
@@ -621,7 +622,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:896
Protected
createAndSetupWorker
@@ -633,7 +634,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:856
Protected
Abstract
createWorker
@@ -645,7 +646,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:849
Private
dequeueTask
@@ -658,7 +659,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1118
+Defined in src/pools/abstract-pool.ts:651
Protected
Abstract
destroyWorker
@@ -689,7 +690,7 @@ Can be overridden.
Returns void | Promise<void>
+Defined in src/pools/abstract-pool.ts:672
+Defined in src/pools/abstract-pool.ts:556
Private
enqueueTask
@@ -729,7 +730,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1114
+Defined in src/pools/abstract-pool.ts:616
Private
executeTask
@@ -776,7 +777,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1109
Private
flushTasksQueue
@@ -789,7 +790,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1126
Private
flushTasksQueues
@@ -797,7 +798,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1136
Private
getWorkerById
@@ -817,13 +818,13 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:491
Private
getWorkerInfo
- getWorkerInfo(workerNodeKey): WorkerInfo
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:1005
Protected
internalBusy
@@ -894,7 +918,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:607
Protected
Abstract
isMain
@@ -905,7 +929,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:687
Private
redistributeQueuedTasks
@@ -918,10 +942,10 @@ Can be overridden.
workerNodeKey: number
Returns void
-
-Private
registerWorkerMessageListener
-
+
+Protected
Abstract
registerWorkerMessageListener
+
- registerWorkerMessageListener<Message>(worker, listener): void
-
Returns void
+Defined in src/pools/abstract-pool.ts:1142
Protected
setupHook
@@ -1104,7 +1134,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:680
Private
shallCreateDynamicWorker
@@ -1116,7 +1146,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:829
Private
startPool
@@ -1124,7 +1154,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:281
Private
tasksQueueSize
@@ -1137,7 +1167,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1122
Private
updateEluWorkerUsage
@@ -1152,7 +1182,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:773
Private
updateRunTimeWorkerUsage
@@ -1167,7 +1197,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:747
Private
updateTaskStatisticsWorkerUsage
@@ -1182,7 +1212,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:734
Private
updateWaitTimeWorkerUsage
@@ -1197,7 +1227,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:759
Protected
workerListener
@@ -1224,7 +1254,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:992
Gets the worker information.
+Gets the worker information from the given worker node key.
Parameters
@@ -833,13 +834,36 @@ Can be overridden.The worker node key.
Returns WorkerInfo
+Returns WorkerInfo
The worker information.
+ - Worker Node Key
-Private
get+- Defined in src/pools/abstract-pool.ts:1056
Worker Info By Worker
+Protected
get+- get
Worker Info By Worker(worker): WorkerInfo
+-
+
+
+
+
+
Gets the worker information from the given worker.
+Parameters
++-
+
+
worker: Worker
+The worker.
+Returns WorkerInfo
The worker information.
+ +Throws
https://nodejs.org/api/errors.html#class-error If the worker is not found.
+ Worker Node Key
+Protected
getGets the given worker its worker node key.
@@ -856,7 +880,7 @@ Can be overridden. +Private
handle@@ -869,7 +893,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
Private
handle@@ -882,7 +906,7 @@ Can be overridden.
message: MessageValue<Response, unknown>