X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=be753f26c66d6837b8e47043f8cb866625b74dfd;hb=0717df3dc168fc35b8268713ac8b7bde86f024a9;hp=5d9c47e5236bc1dd4415ad1ad6d983a6c47191be;hpb=c65efde664ab9e4dcd2ed9e827d8171e7e081359;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 5d9c47e5..be753f26 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.24
+AbstractPool | poolifier - v2.6.31
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:56
@@ -63,6 +63,7 @@
Properties
emitter?
filePath
+
max?
numberOfWorkers
opts
promiseResponseMap
@@ -90,7 +91,9 @@
afterWorkerNodeSetup
beforeTaskExecutionHook
buildTasksQueueOptions
-
checkAndEmitEvents
+
checkAndEmitDynamicWorkerCreationEvents
+
checkAndEmitTaskExecutionEvents
+
checkAndEmitTaskQueuingEvents
checkDynamicPoolSize
checkFilePath
checkMessageWorkerId
@@ -117,19 +120,24 @@
getWorkerNodeKeyByWorkerId
handleTaskExecutionResponse
handleWorkerReadyResponse
+
hasBackPressure
+
hasWorkerNodeBackPressure
internalBusy
isMain
+
listTaskFunctions
redistributeQueuedTasks
registerWorkerMessageListener
removeWorkerNode
+
sendKillMessageToWorker
sendStartupMessageToWorker
+
sendStatisticsMessageToWorker
sendToWorker
-
sendWorkerStatisticsMessageToWorker
setTasksQueueOptions
setWorkerChoiceStrategy
setWorkerChoiceStrategyOptions
setupHook
shallCreateDynamicWorker
+
shallUpdateTaskFunctionWorkerUsage
startPool
tasksQueueSize
updateEluWorkerUsage
@@ -177,7 +185,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:108
Protected
Readonly
filePath
filePath: string
@@ -204,7 +214,15 @@
+Defined in src/pools/abstract-pool.ts:110
+
+Protected
Optional
Readonly
max
+max?: number
+
+
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -212,7 +230,7 @@
+
Defined in src/pools/abstract-pool.ts:109
Protected
Readonly
opts
@@ -220,7 +238,7 @@
+Defined in src/pools/abstract-pool.ts:111
Protected
promiseResponseMap
@@ -233,7 +251,7 @@
+Defined in src/pools/abstract-pool.ts:75
Private
Readonly
startTimestamp
startTimestamp: number
@@ -241,7 +259,7 @@
+Defined in src/pools/abstract-pool.ts:99
Private
Readonly
starting
starting: boolean
@@ -249,7 +267,7 @@
+Defined in src/pools/abstract-pool.ts:95
Protected
workerChoiceStrategyContext
@@ -257,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
@@ -292,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
-
@@ -315,9 +333,9 @@
Returns number
+Defined in src/pools/abstract-pool.ts:525
-Protected
Abstract
minSize
+Protected
minSize
- get minSize(): number
-
@@ -326,7 +344,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:518
Private
ready
@@ -337,7 +355,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:470
Protected
Abstract
type
@@ -349,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
@@ -372,7 +390,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:513
Protected
afterTaskExecutionHook
@@ -421,7 +439,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:834
Protected
afterWorkerNodeSetup
@@ -441,7 +459,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1109
Protected
beforeTaskExecutionHook
@@ -466,7 +484,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:804
Private
buildTasksQueueOptions
@@ -479,15 +497,31 @@ Can be overridden.
-
+
+Private
checkAndEmitDynamicWorkerCreationEvents
+
+- checkAndEmitDynamicWorkerCreationEvents(): void
+-
+
Returns void
+
+Private
checkAndEmitTaskExecutionEvents
+
+- checkAndEmitTaskExecutionEvents(): void
+-
+
Returns void
+
+Private
checkAndEmitTaskQueuingEvents
-- checkAndEmitEvents(): void
+- checkAndEmitTaskQueuingEvents(): void
-
Returns void
+Defined in src/pools/abstract-pool.ts:1260
Protected
checkDynamicPoolSize
@@ -502,7 +536,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:179
Private
checkFilePath
@@ -515,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
@@ -549,7 +583,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:161
Private
checkPoolOptions
@@ -562,7 +596,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:205
Private
checkValidTasksQueueOptions
@@ -575,7 +609,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:287
Private
checkValidWorkerChoiceStrategy
@@ -588,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
@@ -601,7 +635,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:243
Private
chooseWorkerNode
@@ -614,7 +648,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:966
Protected
createAndSetupDynamicWorkerNode
@@ -626,7 +660,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1052
Protected
createAndSetupWorkerNode
@@ -638,7 +672,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1012
Protected
Abstract
createWorker
@@ -650,7 +684,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1005
Private
dequeueTask
@@ -663,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
@@ -694,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
@@ -734,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
@@ -789,7 +823,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1345
Protected
flushTasksQueue
@@ -802,7 +836,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1365
Private
flushTasksQueues
@@ -810,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
-
@@ -826,11 +860,11 @@ Can be overridden.
-The worker information.
+The worker information.
+Defined in src/pools/abstract-pool.ts:1280
Private
getWorkerNodeKeyByWorker
@@ -850,7 +884,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:554
Private
getWorkerNodeKeyByWorkerId
@@ -870,7 +904,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:566
Private
handleTaskExecutionResponse
@@ -883,7 +917,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1226
Private
handleWorkerReadyResponse
@@ -896,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
@@ -908,7 +971,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:657
Protected
Abstract
isMain
@@ -919,7 +982,20 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:795
+
Private
redistributeQueuedTasks
@@ -932,7 +1008,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1143
Protected
Abstract
registerWorkerMessageListener
@@ -972,7 +1048,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1096
Private
removeWorkerNode
@@ -991,7 +1067,22 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1314
+
+Protected
sendKillMessageToWorker
+
+- sendKillMessageToWorker(workerNodeKey, workerId): Promise<void>
+-
+
+
Parameters
+
+-
+
workerNodeKey: number
+-
+
workerId: number
+Returns Promise<void>
Protected
Abstract
sendStartupMessageToWorker
@@ -1010,7 +1101,26 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1123
+
+Private
sendStatisticsMessageToWorker
+
+- sendStatisticsMessageToWorker(workerNodeKey): void
+-
+
+
+
Parameters
+
+-
+
workerNodeKey: number
+
+
+Returns void
+
Protected
Abstract
sendToWorker
@@ -1039,26 +1149,7 @@ Can be overridden.
Returns void
-
-Private
sendWorkerStatisticsMessageToWorker
-
-- sendWorkerStatisticsMessageToWorker(workerNodeKey): void
--
-
-
-
Parameters
-
--
-
workerNodeKey: number
-
-
-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
@@ -1135,7 +1226,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:788
Private
shallCreateDynamicWorker
@@ -1147,7 +1238,27 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:983
+
+Private
shallUpdateTaskFunctionWorkerUsage
+
Private
startPool
@@ -1155,7 +1266,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:311
Private
tasksQueueSize
@@ -1168,7 +1279,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1361
Private
updateEluWorkerUsage
@@ -1183,7 +1294,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:927
Private
updateRunTimeWorkerUsage
@@ -1198,7 +1309,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:901
Private
updateTaskStatisticsWorkerUsage
@@ -1213,7 +1324,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:876
Private
updateWaitTimeWorkerUsage
@@ -1228,7 +1339,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:913
Protected
workerListener
@@ -1255,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).