X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=be753f26c66d6837b8e47043f8cb866625b74dfd;hb=4445abb25ec4c9d80985ca93c65762a6c892a852;hp=2fe2f7cd195f2bbd6499945eb63d4dad225ffc0c;hpb=fd13902fd959335e2c0f95d1b464317a2da8b6cf;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 2fe2f7cd..be753f26 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.30
+AbstractPool | poolifier - v2.6.31
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:56
@@ -185,7 +185,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:108
Protected
Readonly
filePath
filePath: string
@@ -214,7 +214,7 @@
+
Defined in src/pools/abstract-pool.ts:110
Protected
Optional
Readonly
max
max?: number
@@ -222,7 +222,7 @@
+Defined in src/pools/abstract-pool.ts:90
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -230,7 +230,7 @@
+Defined in src/pools/abstract-pool.ts:109
Protected
Readonly
opts
@@ -238,7 +238,7 @@
+Defined in src/pools/abstract-pool.ts:111
Protected
promiseResponseMap
@@ -251,7 +251,7 @@
+Defined in src/pools/abstract-pool.ts:75
Private
Readonly
startTimestamp
startTimestamp: number
@@ -259,7 +259,7 @@
+Defined in src/pools/abstract-pool.ts:99
Private
Readonly
starting
starting: boolean
@@ -267,7 +267,7 @@
+Defined in src/pools/abstract-pool.ts:95
Protected
workerChoiceStrategyContext
@@ -275,7 +275,7 @@
+Defined in src/pools/abstract-pool.ts:81
Readonly
Internal
workerNodes
@@ -284,7 +284,7 @@
+Defined in src/pools/abstract-pool.ts:62
Protected
full
@@ -310,7 +310,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:641
+Defined in src/pools/abstract-pool.ts:324
Protected
maxSize
@@ -333,7 +333,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:525
Protected
minSize
@@ -344,7 +344,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:518
Private
ready
@@ -355,7 +355,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:470
Protected
Abstract
type
@@ -367,7 +367,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:508
+Defined in src/pools/abstract-pool.ts:487
Protected
Abstract
worker
@@ -390,7 +390,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:513
Protected
afterTaskExecutionHook
@@ -439,7 +439,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:834
Protected
afterWorkerNodeSetup
@@ -459,7 +459,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1109
Protected
beforeTaskExecutionHook
@@ -484,7 +484,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:804
Private
buildTasksQueueOptions
@@ -497,7 +497,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:628
Private
checkAndEmitDynamicWorkerCreationEvents
@@ -505,7 +505,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1266
Private
checkAndEmitTaskExecutionEvents
@@ -513,7 +513,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1254
Private
checkAndEmitTaskQueuingEvents
@@ -521,7 +521,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1260
Protected
checkDynamicPoolSize
@@ -536,7 +536,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:179
Private
checkFilePath
@@ -549,7 +549,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:148
Private
checkMessageWorkerId
+Defined in src/pools/abstract-pool.ts:535
Private
checkNumberOfWorkers
@@ -583,7 +583,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:161
Private
checkPoolOptions
@@ -596,7 +596,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:205
Private
checkValidTasksQueueOptions
@@ -609,7 +609,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:287
Private
checkValidWorkerChoiceStrategy
@@ -622,7 +622,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
@@ -635,7 +635,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:243
Private
chooseWorkerNode
@@ -648,7 +648,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:966
Protected
createAndSetupDynamicWorkerNode
@@ -660,7 +660,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1052
Protected
createAndSetupWorkerNode
@@ -672,7 +672,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1012
Protected
Abstract
createWorker
@@ -684,7 +684,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1005
Private
dequeueTask
@@ -697,7 +697,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1357
+Defined in src/pools/abstract-pool.ts:750
Protected
Abstract
destroyWorkerNode
@@ -728,7 +728,7 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:780
+Defined in src/pools/abstract-pool.ts:606
Private
enqueueTask
@@ -768,7 +768,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1351
+Defined in src/pools/abstract-pool.ts:691
Private
executeTask
@@ -823,7 +823,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1345
Protected
flushTasksQueue
@@ -836,7 +836,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1365
Private
flushTasksQueues
@@ -844,11 +844,11 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1375
Protected
getWorkerInfo
-- getWorkerInfo(workerNodeKey): WorkerInfo
+- getWorkerInfo(workerNodeKey): undefined | WorkerInfo
-
@@ -860,11 +860,11 @@ Can be overridden.
-The worker information.
+The worker information.
+Defined in src/pools/abstract-pool.ts:1280
Private
getWorkerNodeKeyByWorker
@@ -884,7 +884,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:554
Private
getWorkerNodeKeyByWorkerId
@@ -904,7 +904,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:566
Private
handleTaskExecutionResponse
@@ -917,7 +917,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1226
Private
handleWorkerReadyResponse
@@ -930,7 +930,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1212
Private
hasBackPressure
@@ -938,7 +938,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:1330
hasWorkerNodeBackPressure
+Defined in src/pools/abstract-pool.ts:1323
Protected
internalBusy
@@ -971,7 +971,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:657
Protected
Abstract
isMain
@@ -982,7 +982,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:795
+Defined in src/pools/abstract-pool.ts:678
Private
redistributeQueuedTasks
@@ -1008,7 +1008,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1143
Protected
Abstract
registerWorkerMessageListener
@@ -1048,7 +1048,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1096
Private
removeWorkerNode
@@ -1067,7 +1067,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1314
Protected
sendKillMessageToWorker
@@ -1082,7 +1082,7 @@ Can be overridden.
workerId: number
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:759
Protected
Abstract
sendStartupMessageToWorker
@@ -1101,7 +1101,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1123
Private
sendStatisticsMessageToWorker
@@ -1120,7 +1120,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1130
Protected
Abstract
sendToWorker
@@ -1149,7 +1149,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:994
+Defined in src/pools/abstract-pool.ts:618
+Defined in src/pools/abstract-pool.ts:573
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:592
Protected
setupHook
@@ -1226,7 +1226,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:788
Private
shallCreateDynamicWorker
@@ -1238,7 +1238,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:983
Private
shallUpdateTaskFunctionWorkerUsage
@@ -1258,7 +1258,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:867
Private
startPool
@@ -1266,7 +1266,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:311
Private
tasksQueueSize
@@ -1279,7 +1279,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1361
Private
updateEluWorkerUsage
@@ -1294,7 +1294,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:927
Private
updateRunTimeWorkerUsage
@@ -1309,7 +1309,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:901
Private
updateTaskStatisticsWorkerUsage
@@ -1324,7 +1324,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:876
Private
updateWaitTimeWorkerUsage
@@ -1339,7 +1339,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:913
Protected
workerListener
@@ -1366,7 +1366,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1192
Gets the worker information given its worker node key.