X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=7f201407c20601a160864b3a7f517daafefb0211;hb=a13e50c30dd0e0714ace0e1ea4ea1b36cdd18ab7;hp=8b279fef929856d2c4c298f1a55104b348cb44ad;hpb=0e16e60a89029abe61cda7ba293c036298cced05;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 8b279fef..7f201407 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.26
+AbstractPool | poolifier - v2.6.27
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:56
@@ -180,7 +180,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:107
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -215,7 +216,7 @@
+
Defined in src/pools/abstract-pool.ts:108
Protected
Readonly
opts
@@ -223,7 +224,7 @@
+Defined in src/pools/abstract-pool.ts:110
Protected
promiseResponseMap
@@ -236,7 +237,7 @@
+Defined in src/pools/abstract-pool.ts:75
Private
Readonly
startTimestamp
startTimestamp: number
@@ -244,7 +245,7 @@
+Defined in src/pools/abstract-pool.ts:94
Private
Readonly
starting
starting: boolean
@@ -252,7 +253,7 @@
+Defined in src/pools/abstract-pool.ts:90
Private
taskFunctions
taskFunctions: string[]
@@ -260,7 +261,7 @@
+Defined in src/pools/abstract-pool.ts:98
Protected
workerChoiceStrategyContext
@@ -268,7 +269,7 @@
+Defined in src/pools/abstract-pool.ts:81
Readonly
workerNodes
@@ -277,7 +278,7 @@
+Defined in src/pools/abstract-pool.ts:62
Protected
full
@@ -303,7 +304,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:613
+Defined in src/pools/abstract-pool.ts:308
Protected
Abstract
maxSize
@@ -326,7 +327,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:504
Protected
Abstract
minSize
@@ -337,7 +338,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:499
Private
ready
@@ -348,7 +349,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:451
Protected
Abstract
type
@@ -360,7 +361,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:489
+Defined in src/pools/abstract-pool.ts:468
Protected
Abstract
worker
@@ -383,7 +384,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:494
Protected
afterTaskExecutionHook
@@ -432,7 +433,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:793
Protected
afterWorkerNodeSetup
@@ -452,7 +453,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1026
Protected
beforeTaskExecutionHook
@@ -477,7 +478,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:772
Private
buildTasksQueueOptions
@@ -490,7 +491,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:600
Private
checkAndEmitEvents
@@ -498,7 +499,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1163
Protected
checkDynamicPoolSize
@@ -513,7 +514,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:180
Private
checkFilePath
@@ -526,7 +527,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:149
Private
checkMessageWorkerId
+Defined in src/pools/abstract-pool.ts:512
Private
checkNumberOfWorkers
@@ -560,7 +561,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:162
Private
checkPoolOptions
@@ -573,7 +574,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:206
Private
checkValidTasksQueueOptions
@@ -586,7 +587,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:271
Private
checkValidWorkerChoiceStrategy
@@ -599,7 +600,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:233
Private
checkValidWorkerChoiceStrategyOptions
@@ -612,7 +613,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:243
Private
chooseWorkerNode
@@ -625,7 +626,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:887
Protected
createAndSetupDynamicWorkerNode
@@ -637,7 +638,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:973
Protected
createAndSetupWorkerNode
@@ -649,7 +650,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:933
Protected
Abstract
createWorker
@@ -661,7 +662,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:926
Private
dequeueTask
@@ -674,7 +675,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1233
+Defined in src/pools/abstract-pool.ts:718
Protected
Abstract
destroyWorkerNode
@@ -705,7 +706,7 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:748
+Defined in src/pools/abstract-pool.ts:578
Private
enqueueTask
@@ -745,7 +746,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1229
+Defined in src/pools/abstract-pool.ts:659
Private
executeTask
@@ -800,7 +801,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1224
Protected
flushTasksQueue
@@ -813,7 +814,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1241
Private
flushTasksQueues
@@ -821,7 +822,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1251
Protected
getWorkerInfo
@@ -841,7 +842,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1180
Private
getWorkerNodeKeyByWorker
@@ -861,7 +862,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:529
Private
getWorkerNodeKeyByWorkerId
@@ -881,7 +882,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:541
Private
handleTaskExecutionResponse
@@ -894,7 +895,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1134
Private
handleWorkerReadyResponse
@@ -907,7 +908,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1125
Protected
internalBusy
@@ -919,7 +920,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:629
Protected
Abstract
isMain
@@ -930,7 +931,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:763
+Defined in src/pools/abstract-pool.ts:650
Private
redistributeQueuedTasks
@@ -956,7 +957,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1060
Protected
Abstract
registerWorkerMessageListener
@@ -996,7 +997,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1013
Private
removeWorkerNode
@@ -1015,7 +1016,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1210
Protected
sendKillMessageToWorker
@@ -1030,7 +1031,7 @@ Can be overridden.
workerId: number
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:727
Protected
Abstract
sendStartupMessageToWorker
@@ -1049,7 +1050,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1040
Private
sendStatisticsMessageToWorker
@@ -1068,7 +1069,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1047
Protected
Abstract
sendToWorker
@@ -1097,7 +1098,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:915
+Defined in src/pools/abstract-pool.ts:590
+Defined in src/pools/abstract-pool.ts:548
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:567
Protected
setupHook
@@ -1174,7 +1175,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:756
Private
shallCreateDynamicWorker
@@ -1186,7 +1187,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:904
Private
startPool
@@ -1194,7 +1195,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:295
Private
tasksQueueSize
@@ -1207,7 +1208,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1237
Private
updateEluWorkerUsage
@@ -1222,7 +1223,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:848
Private
updateRunTimeWorkerUsage
@@ -1237,7 +1238,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:822
Private
updateTaskStatisticsWorkerUsage
@@ -1252,7 +1253,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:809
Private
updateWaitTimeWorkerUsage
@@ -1267,7 +1268,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:834
Protected
workerListener
@@ -1294,7 +1295,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1109
Emitter on which events can be listened to.
Events that can currently be listened to:
-
+
+- '
@@ -199,7 +200,7 @@ +'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'ready'
: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.destroy
': Emitted when the pool is destroyed.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.Protected
Readonly
file