X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=d633e72ee14b0a655fbb17da2e69b2ba94ddd6cf;hb=c22b117f8593bba575a4385b8f125f14b4bf1099;hp=5d9c47e5236bc1dd4415ad1ad6d983a6c47191be;hpb=2447ee8ce5d3db1253c7286482e5a54e84618ecf;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 5d9c47e5..d633e72e 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.24
+AbstractPool | poolifier - v2.6.29
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:56
+
Defined in src/pools/abstract-pool.ts:103
Protected
Readonly
filePath
filePath: string
@@ -204,7 +211,7 @@
+
Defined in src/pools/abstract-pool.ts:105
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -212,7 +219,7 @@
+Defined in src/pools/abstract-pool.ts:104
Protected
Readonly
opts
@@ -220,7 +227,7 @@
+Defined in src/pools/abstract-pool.ts:106
Protected
promiseResponseMap
@@ -233,7 +240,7 @@
+Defined in src/pools/abstract-pool.ts:75
Private
Readonly
startTimestamp
startTimestamp: number
@@ -241,7 +248,7 @@
+Defined in src/pools/abstract-pool.ts:94
Private
Readonly
starting
starting: boolean
@@ -249,7 +256,7 @@
+Defined in src/pools/abstract-pool.ts:90
Protected
workerChoiceStrategyContext
@@ -257,16 +264,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 +299,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:631
+Defined in src/pools/abstract-pool.ts:321
Protected
Abstract
maxSize
@@ -315,7 +322,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:517
Protected
Abstract
minSize
@@ -326,7 +333,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:512
Private
ready
@@ -337,7 +344,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:464
Protected
Abstract
type
@@ -349,7 +356,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:502
+Defined in src/pools/abstract-pool.ts:481
Protected
Abstract
worker
@@ -372,7 +379,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:507
Protected
afterTaskExecutionHook
@@ -421,7 +428,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:818
Protected
afterWorkerNodeSetup
@@ -441,7 +448,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1081
Protected
beforeTaskExecutionHook
@@ -466,7 +473,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:795
Private
buildTasksQueueOptions
@@ -479,7 +486,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:618
Private
checkAndEmitEvents
@@ -487,7 +494,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1224
Protected
checkDynamicPoolSize
@@ -502,7 +509,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:176
Private
checkFilePath
@@ -515,7 +522,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:145
Private
checkMessageWorkerId
+Defined in src/pools/abstract-pool.ts:525
Private
checkNumberOfWorkers
@@ -549,7 +556,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:158
Private
checkPoolOptions
@@ -562,7 +569,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:202
Private
checkValidTasksQueueOptions
@@ -575,7 +582,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:284
Private
checkValidWorkerChoiceStrategy
@@ -588,7 +595,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:230
Private
checkValidWorkerChoiceStrategyOptions
@@ -601,7 +608,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:240
Private
chooseWorkerNode
@@ -614,7 +621,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:942
Protected
createAndSetupDynamicWorkerNode
@@ -626,7 +633,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1028
Protected
createAndSetupWorkerNode
@@ -638,7 +645,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:988
Protected
Abstract
createWorker
@@ -650,7 +657,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:981
Private
dequeueTask
@@ -663,7 +670,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1319
+Defined in src/pools/abstract-pool.ts:741
Protected
Abstract
destroyWorkerNode
@@ -694,7 +701,7 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:771
+Defined in src/pools/abstract-pool.ts:596
Private
enqueueTask
@@ -734,7 +741,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1311
+Defined in src/pools/abstract-pool.ts:681
Private
executeTask
@@ -789,7 +796,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1306
Protected
flushTasksQueue
@@ -802,7 +809,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1327
Private
flushTasksQueues
@@ -810,7 +817,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1337
Protected
getWorkerInfo
@@ -830,7 +837,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1241
Private
getWorkerNodeKeyByWorker
@@ -850,7 +857,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:544
Private
getWorkerNodeKeyByWorkerId
@@ -870,7 +877,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:556
Private
handleTaskExecutionResponse
@@ -883,7 +890,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1196
Private
handleWorkerReadyResponse
@@ -896,7 +903,36 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1182
+
+Private
hasBackPressure
+
+- hasBackPressure(): boolean
+-
+
Returns boolean
+
+hasWorkerNodeBackPressure
+
Protected
internalBusy
@@ -908,7 +944,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:647
Protected
Abstract
isMain
@@ -919,7 +955,20 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:786
+
Private
redistributeQueuedTasks
@@ -932,7 +981,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1115
Protected
Abstract
registerWorkerMessageListener
@@ -972,7 +1021,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1068
Private
removeWorkerNode
@@ -991,7 +1040,22 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1275
+
+Protected
sendKillMessageToWorker
+
+- sendKillMessageToWorker(workerNodeKey, workerId): Promise<void>
+-
+
+
Parameters
+
+-
+
workerNodeKey: number
+-
+
workerId: number
+Returns Promise<void>
Protected
Abstract
sendStartupMessageToWorker
@@ -1010,7 +1074,26 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1095
+
+Private
sendStatisticsMessageToWorker
+
+- sendStatisticsMessageToWorker(workerNodeKey): void
+-
+
+
+
Parameters
+
+-
+
workerNodeKey: number
+
+
+Returns void
+
Protected
Abstract
sendToWorker
@@ -1039,26 +1122,7 @@ Can be overridden.
Returns void
-
-Private
sendWorkerStatisticsMessageToWorker
-
-- sendWorkerStatisticsMessageToWorker(workerNodeKey): void
--
-
-
-
Parameters
-
--
-
workerNodeKey: number
-
-
-Returns void
-
+Defined in src/pools/abstract-pool.ts:970
+Defined in src/pools/abstract-pool.ts:608
+Defined in src/pools/abstract-pool.ts:563
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:582
Protected
setupHook
@@ -1135,7 +1199,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:779
Private
shallCreateDynamicWorker
@@ -1147,7 +1211,27 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:959
+
+Private
shallUpdateTaskFunctionWorkerUsage
+
Private
startPool
@@ -1155,7 +1239,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:308
Private
tasksQueueSize
@@ -1168,7 +1252,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1323
Private
updateEluWorkerUsage
@@ -1183,7 +1267,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:903
Private
updateRunTimeWorkerUsage
@@ -1198,7 +1282,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:877
Private
updateTaskStatisticsWorkerUsage
@@ -1213,7 +1297,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:852
Private
updateWaitTimeWorkerUsage
@@ -1228,7 +1312,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:889
Protected
workerListener
@@ -1255,7 +1339,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1164
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).