X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=aff9850dd46ceb55e6088a5de0ea9e4d8b744410;hb=a93f5559e2dd5ff7fd49afdd43bc9806cff92f56;hp=d633e72ee14b0a655fbb17da2e69b2ba94ddd6cf;hpb=c22b117f8593bba575a4385b8f125f14b4bf1099;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index d633e72e..aff9850d 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.29
+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
@@ -129,6 +133,7 @@
sendStartupMessageToWorker
sendStatisticsMessageToWorker
sendToWorker
+
setTasksQueueMaxSize
setTasksQueueOptions
setWorkerChoiceStrategy
setWorkerChoiceStrategyOptions
@@ -137,6 +142,7 @@
shallUpdateTaskFunctionWorkerUsage
startPool
tasksQueueSize
+
tasksStealingOnBackPressure
updateEluWorkerUsage
updateRunTimeWorkerUsage
updateTaskStatisticsWorkerUsage
@@ -182,7 +188,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:112
Properties
@@ -197,13 +203,13 @@
'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).
+'backPressure'
: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
+Defined in src/pools/abstract-pool.ts:65
Protected
Readonly
filePath
filePath: string
@@ -211,7 +217,15 @@
+
Defined in src/pools/abstract-pool.ts:114
+
+Protected
Optional
Readonly
max
+max?: number
+
+
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -219,7 +233,7 @@
+Defined in src/pools/abstract-pool.ts:113
Protected
Readonly
opts
@@ -227,7 +241,7 @@
+Defined in src/pools/abstract-pool.ts:115
Protected
promiseResponseMap
@@ -240,7 +254,7 @@
+Defined in src/pools/abstract-pool.ts:75
Private
Readonly
startTimestamp
startTimestamp: number
@@ -248,7 +262,15 @@
+Defined in src/pools/abstract-pool.ts:103
+
+Private
started
+started: boolean
+
+
Private
Readonly
starting
starting: boolean
@@ -256,7 +278,7 @@
+Defined in src/pools/abstract-pool.ts:95
Protected
workerChoiceStrategyContext
@@ -264,7 +286,7 @@
+Defined in src/pools/abstract-pool.ts:81
Readonly
Internal
workerNodes
@@ -273,7 +295,7 @@
+Defined in src/pools/abstract-pool.ts:62
Protected
full
@@ -299,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
-
@@ -322,9 +344,9 @@
Returns number
+Defined in src/pools/abstract-pool.ts:546
-Protected
Abstract
minSize
+Protected
minSize
- get minSize(): number
-
@@ -333,7 +355,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:539
Private
ready
@@ -344,7 +366,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:491
Protected
Abstract
type
@@ -356,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
@@ -379,7 +401,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:534
Protected
afterTaskExecutionHook
@@ -428,7 +450,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:872
Protected
afterWorkerNodeSetup
@@ -448,7 +470,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1144
Protected
beforeTaskExecutionHook
@@ -473,7 +495,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:842
Private
buildTasksQueueOptions
@@ -486,15 +508,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:1329
Protected
checkDynamicPoolSize
@@ -509,7 +547,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:184
Private
checkFilePath
@@ -522,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
@@ -556,7 +594,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:166
Private
checkPoolOptions
@@ -569,7 +607,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:210
Private
checkValidTasksQueueOptions
@@ -582,7 +620,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:292
Private
checkValidWorkerChoiceStrategy
@@ -595,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
@@ -608,7 +646,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:248
Private
chooseWorkerNode
@@ -621,7 +659,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:997
Protected
createAndSetupDynamicWorkerNode
@@ -633,7 +671,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1087
Protected
createAndSetupWorkerNode
@@ -645,7 +683,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1043
Protected
Abstract
createWorker
@@ -657,7 +695,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1036
Private
dequeueTask
@@ -670,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
@@ -701,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
@@ -857,7 +895,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:575
Private
getWorkerNodeKeyByWorkerId
@@ -877,7 +915,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:587
Private
handleTaskExecutionResponse
@@ -890,7 +928,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1295
Private
handleWorkerReadyResponse
@@ -903,7 +941,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1281
Private
hasBackPressure
@@ -911,7 +949,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:1399
hasWorkerNodeBackPressure
+Defined in src/pools/abstract-pool.ts:1392
Protected
internalBusy
@@ -944,7 +982,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:691
Protected
Abstract
isMain
@@ -955,7 +993,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:833
+Defined in src/pools/abstract-pool.ts:712
Private
redistributeQueuedTasks
@@ -981,7 +1019,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1182
Protected
Abstract
registerWorkerMessageListener
@@ -1021,7 +1059,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1131
Private
removeWorkerNode
@@ -1040,7 +1078,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1383
Protected
sendKillMessageToWorker
@@ -1055,7 +1093,7 @@ Can be overridden.
workerId: number
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:797
Protected
Abstract
sendStartupMessageToWorker
@@ -1074,7 +1112,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1162
Private
sendStatisticsMessageToWorker
@@ -1093,7 +1131,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1169
Protected
Abstract
sendToWorker
@@ -1122,27 +1160,40 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1025
+
+Private
setTasksQueueMaxSize
+
+- setTasksQueueMaxSize(queueMaxSize): void
+-
+
+
Returns void
setTasksQueueOptions
- setTasksQueueOptions(tasksQueueOptions): void
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:958
Private
updateRunTimeWorkerUsage
@@ -1282,7 +1346,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:932
Private
updateTaskStatisticsWorkerUsage
@@ -1297,7 +1361,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:914
Private
updateWaitTimeWorkerUsage
@@ -1312,7 +1376,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:944
Protected
workerListener
@@ -1339,7 +1403,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1261
Dynamic pool maximum size property placeholder.
+