X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=00d68b3d181866d60a64610ffe52a9cd7260643a;hb=969223ea18802a84dfea369e254332e11bf8e419;hp=5d9c47e5236bc1dd4415ad1ad6d983a6c47191be;hpb=2447ee8ce5d3db1253c7286482e5a54e84618ecf;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 5d9c47e5..00d68b3d 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.24
+AbstractPool | poolifier - v2.6.33
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:57
@@ -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,29 @@
getWorkerNodeKeyByWorkerId
handleTaskExecutionResponse
handleWorkerReadyResponse
+
hasBackPressure
+
hasWorkerNodeBackPressure
internalBusy
isMain
+
listTaskFunctions
redistributeQueuedTasks
registerWorkerMessageListener
removeWorkerNode
+
sendKillMessageToWorker
sendStartupMessageToWorker
+
sendStatisticsMessageToWorker
sendToWorker
-
sendWorkerStatisticsMessageToWorker
+
setTasksQueueMaxSize
setTasksQueueOptions
setWorkerChoiceStrategy
setWorkerChoiceStrategyOptions
setupHook
shallCreateDynamicWorker
+
shallUpdateTaskFunctionWorkerUsage
startPool
+
taskStealingOnEmptyQueue
tasksQueueSize
+
tasksStealingOnBackPressure
updateEluWorkerUsage
updateRunTimeWorkerUsage
updateTaskStatisticsWorkerUsage
@@ -177,7 +189,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:113
Protected
Readonly
filePath
filePath: string
@@ -204,7 +218,15 @@
+Defined in src/pools/abstract-pool.ts:115
+
+Protected
Optional
Readonly
max
+max?: number
+
+
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -212,7 +234,7 @@
+
Defined in src/pools/abstract-pool.ts:114
Protected
Readonly
opts
@@ -220,7 +242,7 @@
+Defined in src/pools/abstract-pool.ts:116
Protected
promiseResponseMap
@@ -233,7 +255,7 @@
+Defined in src/pools/abstract-pool.ts:76
Private
Readonly
startTimestamp
startTimestamp: number
@@ -241,7 +263,15 @@
+Defined in src/pools/abstract-pool.ts:104
+
+Private
started
+started: boolean
+
+
Private
Readonly
starting
starting: boolean
@@ -249,7 +279,7 @@
+Defined in src/pools/abstract-pool.ts:96
Protected
workerChoiceStrategyContext
@@ -257,16 +287,16 @@
+Defined in src/pools/abstract-pool.ts:82
-Readonly
workerNodes
+Readonly
Internal
workerNodes
+Defined in src/pools/abstract-pool.ts:63
Protected
full
@@ -292,7 +322,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:682
+Defined in src/pools/abstract-pool.ts:354
-Protected
Abstract
maxSize
+Protected
maxSize
- get maxSize(): number
-
@@ -315,9 +345,9 @@
Returns number
+Defined in src/pools/abstract-pool.ts:555
-Protected
Abstract
minSize
+Protected
minSize
- get minSize(): number
-
@@ -326,7 +356,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:548
Private
ready
@@ -337,7 +367,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:500
Protected
Abstract
type
@@ -349,7 +379,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:538
+Defined in src/pools/abstract-pool.ts:517
Protected
Abstract
worker
@@ -372,7 +402,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:543
Protected
afterTaskExecutionHook
@@ -421,7 +451,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:879
Protected
afterWorkerNodeSetup
@@ -441,7 +471,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1151
Protected
beforeTaskExecutionHook
@@ -466,7 +496,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:849
Private
buildTasksQueueOptions
@@ -479,15 +509,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:1364
+
+Private
checkAndEmitTaskQueuingEvents
+
+- checkAndEmitTaskQueuingEvents(): void
+-
+
Returns void
Protected
checkDynamicPoolSize
@@ -502,7 +548,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:185
Private
checkFilePath
@@ -515,7 +561,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:154
Private
checkMessageWorkerId
+Defined in src/pools/abstract-pool.ts:565
Private
checkNumberOfWorkers
@@ -549,7 +595,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:167
Private
checkPoolOptions
@@ -562,7 +608,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:211
Private
checkValidTasksQueueOptions
@@ -572,10 +618,10 @@ Can be overridden.
Parameters
+
Returns void
+Defined in src/pools/abstract-pool.ts:293
Private
checkValidWorkerChoiceStrategy
@@ -588,7 +634,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:239
Private
checkValidWorkerChoiceStrategyOptions
@@ -601,7 +647,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:249
Private
chooseWorkerNode
@@ -614,7 +660,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1004
Protected
createAndSetupDynamicWorkerNode
@@ -626,7 +672,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1094
Protected
createAndSetupWorkerNode
@@ -638,7 +684,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1050
Protected
Abstract
createWorker
@@ -650,7 +696,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1043
Private
dequeueTask
@@ -663,7 +709,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1467
+Defined in src/pools/abstract-pool.ts:794
Protected
Abstract
destroyWorkerNode
@@ -694,32 +740,32 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:825
enableTasksQueue
- enableTasksQueue(enable, tasksQueueOptions?): void
-
-
-
The worker information.
+The worker information.
+Defined in src/pools/abstract-pool.ts:1390
Private
getWorkerNodeKeyByWorker
@@ -850,7 +896,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:584
Private
getWorkerNodeKeyByWorkerId
@@ -870,7 +916,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:596
Private
handleTaskExecutionResponse
@@ -883,7 +929,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1336
Private
handleWorkerReadyResponse
@@ -896,7 +942,36 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1322
+
+Private
hasBackPressure
+
+- hasBackPressure(): boolean
+-
+
Returns boolean
+
+hasWorkerNodeBackPressure
+
Protected
internalBusy
@@ -908,7 +983,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:698
Protected
Abstract
isMain
@@ -919,7 +994,20 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:840
+
Private
redistributeQueuedTasks
@@ -932,7 +1020,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1191
Protected
Abstract
registerWorkerMessageListener
@@ -972,7 +1060,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1138
Private
removeWorkerNode
@@ -991,7 +1079,22 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1424
+
+Protected
sendKillMessageToWorker
+
+- sendKillMessageToWorker(workerNodeKey, workerId): Promise<void>
+-
+
+
Parameters
+
+-
+
workerNodeKey: number
+-
+
workerId: number
+Returns Promise<void>
Protected
Abstract
sendStartupMessageToWorker
@@ -1010,7 +1113,26 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1171
+
+Private
sendStatisticsMessageToWorker
+
+- sendStatisticsMessageToWorker(workerNodeKey): void
+-
+
+
+
Parameters
+
+-
+
workerNodeKey: number
+
+
+Returns void
+
Protected
Abstract
sendToWorker
@@ -1039,46 +1161,40 @@ Can be overridden.
Returns void
-
+
+Private
setTasksQueueMaxSize
-- sendWorkerStatisticsMessageToWorker(workerNodeKey): void
+- setTasksQueueMaxSize(size): void
-
-
Parameters
-
-
workerNodeKey: number
-
-
-Returns void
-
+Returns void
+Defined in src/pools/abstract-pool.ts:659
setTasksQueueOptions
- setTasksQueueOptions(tasksQueueOptions): void
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:965
Private
updateRunTimeWorkerUsage
@@ -1198,7 +1360,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:939
Private
updateTaskStatisticsWorkerUsage
@@ -1213,7 +1375,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:921
Private
updateWaitTimeWorkerUsage
@@ -1228,7 +1390,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:951
Protected
workerListener
@@ -1255,7 +1417,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1302
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).