X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=be753f26c66d6837b8e47043f8cb866625b74dfd;hb=4445abb25ec4c9d80985ca93c65762a6c892a852;hp=46d2b3f6752156f0729fa675f5483a4abe9959ea;hpb=013a4697317eeedbe32d0e233b2e255027dd84fe;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 46d2b3f6..be753f26 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.26
+AbstractPool | poolifier - v2.6.31
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:56
@@ -63,12 +63,12 @@
Properties
@@ -91,7 +91,9 @@
afterWorkerNodeSetup
beforeTaskExecutionHook
buildTasksQueueOptions
-checkAndEmitEvents
+checkAndEmitDynamicWorkerCreationEvents
+checkAndEmitTaskExecutionEvents
+checkAndEmitTaskQueuingEvents
checkDynamicPoolSize
checkFilePath
checkMessageWorkerId
@@ -118,6 +120,8 @@
getWorkerNodeKeyByWorkerId
handleTaskExecutionResponse
handleWorkerReadyResponse
+hasBackPressure
+hasWorkerNodeBackPressure
internalBusy
isMain
listTaskFunctions
@@ -133,6 +137,7 @@
setWorkerChoiceStrategyOptions
setupHook
shallCreateDynamicWorker
+shallUpdateTaskFunctionWorkerUsage
startPool
tasksQueueSize
updateEluWorkerUsage
@@ -180,7 +185,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:108
Protected
Readonly
filePath
filePath: string
@@ -207,7 +214,15 @@
+
Defined in src/pools/abstract-pool.ts:110
+
+Protected
Optional
Readonly
max
+max?: number
+
+
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -215,7 +230,7 @@
+Defined in src/pools/abstract-pool.ts:109
Protected
Readonly
opts
@@ -223,7 +238,7 @@
+Defined in src/pools/abstract-pool.ts:111
Protected
promiseResponseMap
@@ -236,7 +251,7 @@
+Defined in src/pools/abstract-pool.ts:75
Private
Readonly
startTimestamp
startTimestamp: number
@@ -244,7 +259,7 @@
+Defined in src/pools/abstract-pool.ts:99
Private
Readonly
starting
starting: boolean
@@ -252,15 +267,7 @@
-
-Private
taskFunctions
-taskFunctions: string[]
-
-
+Defined in src/pools/abstract-pool.ts:95
Protected
workerChoiceStrategyContext
@@ -268,16 +275,16 @@
+Defined in src/pools/abstract-pool.ts:81
-Readonly
workerNodes
+Readonly
Internal
workerNodes
+Defined in src/pools/abstract-pool.ts:62
Protected
full
@@ -303,7 +310,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:641
+Defined in src/pools/abstract-pool.ts:324
-Protected
Abstract
maxSize
+Protected
maxSize
- get maxSize(): number
-
@@ -326,9 +333,9 @@
Returns number
+Defined in src/pools/abstract-pool.ts:525
-Protected
Abstract
minSize
+Protected
minSize
- get minSize(): number
-
@@ -337,7 +344,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:518
Private
ready
@@ -348,7 +355,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:470
Protected
Abstract
type
@@ -360,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
@@ -383,7 +390,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:513
Protected
afterTaskExecutionHook
@@ -432,7 +439,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:834
Protected
afterWorkerNodeSetup
@@ -452,7 +459,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1109
Protected
beforeTaskExecutionHook
@@ -477,7 +484,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:804
Private
buildTasksQueueOptions
@@ -490,15 +497,31 @@ Can be overridden.
-
+
+Private
checkAndEmitDynamicWorkerCreationEvents
+
+- checkAndEmitDynamicWorkerCreationEvents(): void
+-
+
Returns void
+
+Private
checkAndEmitTaskExecutionEvents
-- checkAndEmitEvents(): void
+- checkAndEmitTaskExecutionEvents(): void
-
Returns void
+Defined in src/pools/abstract-pool.ts:1254
+
+Private
checkAndEmitTaskQueuingEvents
+
+- checkAndEmitTaskQueuingEvents(): void
+-
+
Returns void
Protected
checkDynamicPoolSize
@@ -513,7 +536,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:179
Private
checkFilePath
@@ -526,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
@@ -560,7 +583,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:161
Private
checkPoolOptions
@@ -573,7 +596,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:205
Private
checkValidTasksQueueOptions
@@ -586,7 +609,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:287
Private
checkValidWorkerChoiceStrategy
@@ -599,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
@@ -612,7 +635,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:243
Private
chooseWorkerNode
@@ -625,7 +648,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:966
Protected
createAndSetupDynamicWorkerNode
@@ -637,7 +660,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1052
Protected
createAndSetupWorkerNode
@@ -649,7 +672,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1012
Protected
Abstract
createWorker
@@ -661,7 +684,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1005
Private
dequeueTask
@@ -674,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
@@ -705,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
@@ -745,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
@@ -800,7 +823,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1345
Protected
flushTasksQueue
@@ -813,7 +836,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1365
Private
flushTasksQueues
@@ -821,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
-
@@ -837,11 +860,11 @@ Can be overridden.
-The worker information.
+The worker information.
+Defined in src/pools/abstract-pool.ts:1280
Private
getWorkerNodeKeyByWorker
@@ -861,7 +884,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:554
Private
getWorkerNodeKeyByWorkerId
@@ -881,7 +904,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:566
Private
handleTaskExecutionResponse
@@ -894,7 +917,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1226
Private
handleWorkerReadyResponse
@@ -907,7 +930,36 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1212
+
+Private
hasBackPressure
+
+- hasBackPressure(): boolean
+-
+
Returns boolean
+
+hasWorkerNodeBackPressure
+
Protected
internalBusy
@@ -919,7 +971,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:657
Protected
Abstract
isMain
@@ -930,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
@@ -956,7 +1008,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1143
Protected
Abstract
registerWorkerMessageListener
@@ -996,7 +1048,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1096
Private
removeWorkerNode
@@ -1015,7 +1067,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1314
Protected
sendKillMessageToWorker
@@ -1030,7 +1082,7 @@ Can be overridden.
workerId: number
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:759
Protected
Abstract
sendStartupMessageToWorker
@@ -1049,7 +1101,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1123
Private
sendStatisticsMessageToWorker
@@ -1068,7 +1120,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1130
Protected
Abstract
sendToWorker
@@ -1097,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
@@ -1174,7 +1226,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:788
Private
shallCreateDynamicWorker
@@ -1186,7 +1238,27 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:983
+
+Private
shallUpdateTaskFunctionWorkerUsage
+
Private
startPool
@@ -1194,7 +1266,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:311
Private
tasksQueueSize
@@ -1207,7 +1279,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1361
Private
updateEluWorkerUsage
@@ -1222,7 +1294,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:927
Private
updateRunTimeWorkerUsage
@@ -1237,7 +1309,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:901
Private
updateTaskStatisticsWorkerUsage
@@ -1252,7 +1324,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:876
Private
updateWaitTimeWorkerUsage
@@ -1267,7 +1339,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:913
Protected
workerListener
@@ -1294,7 +1366,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1192
Emitter on which events can be listened to.
Events that can currently be listened to:
-
+
+- '
+
'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.'backPressure'
: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= pool maximum size^2).