X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=aff9850dd46ceb55e6088a5de0ea9e4d8b744410;hb=a93f5559e2dd5ff7fd49afdd43bc9806cff92f56;hp=fed14871d0bf865335550610105d45cdbd2823d4;hpb=8ad621cc1d32ed396fca3ef2ec48337e42d2dcc2;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index fed14871..aff9850d 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.25
+AbstractPool | poolifier - v2.6.32
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:56
@@ -63,10 +63,12 @@
Properties
emitter?
filePath
+
max?
numberOfWorkers
opts
promiseResponseMap
startTimestamp
+
started
starting
workerChoiceStrategyContext
workerNodes
@@ -90,7 +92,9 @@
afterWorkerNodeSetup
beforeTaskExecutionHook
buildTasksQueueOptions
-
checkAndEmitEvents
+
checkAndEmitDynamicWorkerCreationEvents
+
checkAndEmitTaskExecutionEvents
+
checkAndEmitTaskQueuingEvents
checkDynamicPoolSize
checkFilePath
checkMessageWorkerId
@@ -117,21 +121,28 @@
getWorkerNodeKeyByWorkerId
handleTaskExecutionResponse
handleWorkerReadyResponse
+
hasBackPressure
+
hasWorkerNodeBackPressure
internalBusy
isMain
+
listTaskFunctions
redistributeQueuedTasks
registerWorkerMessageListener
removeWorkerNode
+
sendKillMessageToWorker
sendStartupMessageToWorker
+
sendStatisticsMessageToWorker
sendToWorker
-
sendWorkerStatisticsMessageToWorker
+
setTasksQueueMaxSize
setTasksQueueOptions
setWorkerChoiceStrategy
setWorkerChoiceStrategyOptions
setupHook
shallCreateDynamicWorker
+
shallUpdateTaskFunctionWorkerUsage
startPool
tasksQueueSize
+
tasksStealingOnBackPressure
updateEluWorkerUsage
updateRunTimeWorkerUsage
updateTaskStatisticsWorkerUsage
@@ -177,7 +188,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:112
Protected
Readonly
filePath
filePath: string
@@ -204,7 +217,15 @@
+Defined in src/pools/abstract-pool.ts:114
+
+Protected
Optional
Readonly
max
+max?: number
+
+
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -212,7 +233,7 @@
+
Defined in src/pools/abstract-pool.ts:113
Protected
Readonly
opts
@@ -220,7 +241,7 @@
+Defined in src/pools/abstract-pool.ts:115
Protected
promiseResponseMap
@@ -233,7 +254,7 @@
+Defined in src/pools/abstract-pool.ts:75
Private
Readonly
startTimestamp
startTimestamp: number
@@ -241,7 +262,15 @@
+Defined in src/pools/abstract-pool.ts:103
+
+Private
started
+started: boolean
+
+
Private
Readonly
starting
starting: boolean
@@ -249,7 +278,7 @@
+Defined in src/pools/abstract-pool.ts:95
Protected
workerChoiceStrategyContext
@@ -257,16 +286,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 +321,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:675
+Defined in src/pools/abstract-pool.ts:345
-Protected
Abstract
maxSize
+Protected
maxSize
- get maxSize(): number
-
@@ -315,9 +344,9 @@
Returns number
+Defined in src/pools/abstract-pool.ts:546
-Protected
Abstract
minSize
+Protected
minSize
- get minSize(): number
-
@@ -326,7 +355,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:539
Private
ready
@@ -337,7 +366,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:491
Protected
Abstract
type
@@ -349,7 +378,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:529
+Defined in src/pools/abstract-pool.ts:508
Protected
Abstract
worker
@@ -372,7 +401,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:534
Protected
afterTaskExecutionHook
@@ -421,7 +450,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:872
Protected
afterWorkerNodeSetup
@@ -441,7 +470,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1144
Protected
beforeTaskExecutionHook
@@ -466,7 +495,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:842
Private
buildTasksQueueOptions
@@ -479,15 +508,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:1323
+
+Private
checkAndEmitTaskQueuingEvents
+
+- checkAndEmitTaskQueuingEvents(): void
+-
+
Returns void
Protected
checkDynamicPoolSize
@@ -502,7 +547,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:184
Private
checkFilePath
@@ -515,7 +560,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:153
Private
checkMessageWorkerId
+Defined in src/pools/abstract-pool.ts:556
Private
checkNumberOfWorkers
@@ -549,7 +594,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:166
Private
checkPoolOptions
@@ -562,7 +607,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:210
Private
checkValidTasksQueueOptions
@@ -575,7 +620,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:292
Private
checkValidWorkerChoiceStrategy
@@ -588,7 +633,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:238
Private
checkValidWorkerChoiceStrategyOptions
@@ -601,7 +646,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:248
Private
chooseWorkerNode
@@ -614,7 +659,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:997
Protected
createAndSetupDynamicWorkerNode
@@ -626,7 +671,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1087
Protected
createAndSetupWorkerNode
@@ -638,7 +683,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1043
Protected
Abstract
createWorker
@@ -650,7 +695,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1036
Private
dequeueTask
@@ -663,7 +708,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1426
+Defined in src/pools/abstract-pool.ts:787
Protected
Abstract
destroyWorkerNode
@@ -694,32 +739,32 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:818
enableTasksQueue
- enableTasksQueue(enable, tasksQueueOptions?): void
-
-
-
The worker information.
+The worker information.
+Defined in src/pools/abstract-pool.ts:1349
Private
getWorkerNodeKeyByWorker
@@ -850,7 +895,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:575
Private
getWorkerNodeKeyByWorkerId
@@ -870,7 +915,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:587
Private
handleTaskExecutionResponse
@@ -883,7 +928,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1295
Private
handleWorkerReadyResponse
@@ -896,7 +941,36 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1281
+
+Private
hasBackPressure
+
+- hasBackPressure(): boolean
+-
+
Returns boolean
+
+hasWorkerNodeBackPressure
+
Protected
internalBusy
@@ -908,7 +982,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:691
Protected
Abstract
isMain
@@ -919,7 +993,20 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:833
+
Private
redistributeQueuedTasks
@@ -932,7 +1019,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1182
Protected
Abstract
registerWorkerMessageListener
@@ -972,7 +1059,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1131
Private
removeWorkerNode
@@ -991,7 +1078,22 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1383
+
+Protected
sendKillMessageToWorker
+
+- sendKillMessageToWorker(workerNodeKey, workerId): Promise<void>
+-
+
+
Parameters
+
+-
+
workerNodeKey: number
+-
+
workerId: number
+Returns Promise<void>
Protected
Abstract
sendStartupMessageToWorker
@@ -1010,7 +1112,26 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1162
+
+Private
sendStatisticsMessageToWorker
+
+- sendStatisticsMessageToWorker(workerNodeKey): void
+-
+
+
+
Parameters
+
+-
+
workerNodeKey: number
+
+
+Returns void
+
Protected
Abstract
sendToWorker
@@ -1039,46 +1160,40 @@ Can be overridden.
Returns void
-
+
+Private
setTasksQueueMaxSize
-- sendWorkerStatisticsMessageToWorker(workerNodeKey): void
+- setTasksQueueMaxSize(queueMaxSize): void
-
-
Parameters
-
-
workerNodeKey: number
-
-
-Returns void
-
+Returns void
+Defined in src/pools/abstract-pool.ts:652
setTasksQueueOptions
- setTasksQueueOptions(tasksQueueOptions): void
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:958
Private
updateRunTimeWorkerUsage
@@ -1198,7 +1346,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:932
Private
updateTaskStatisticsWorkerUsage
@@ -1213,7 +1361,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:914
Private
updateWaitTimeWorkerUsage
@@ -1228,7 +1376,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:944
Protected
workerListener
@@ -1255,7 +1403,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1261
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 >= maximum queue size).