X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=e0ce9367d8156b3d8f65f10367f605703ed569ee;hb=26fb3c18b678a1daab6b18a351a238fb5a3ed5df;hp=d633e72ee14b0a655fbb17da2e69b2ba94ddd6cf;hpb=c22b117f8593bba575a4385b8f125f14b4bf1099;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index d633e72e..e0ce9367 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.29
+AbstractPool | poolifier - v2.6.35
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:58
@@ -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
@@ -136,7 +141,9 @@
shallCreateDynamicWorker
shallUpdateTaskFunctionWorkerUsage
startPool
+
taskStealingOnEmptyQueue
tasksQueueSize
+
tasksStealingOnBackPressure
updateEluWorkerUsage
updateRunTimeWorkerUsage
updateTaskStatisticsWorkerUsage
@@ -182,7 +189,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:114
Properties
@@ -194,16 +201,16 @@
'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.
+'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:67
Protected
Readonly
filePath
filePath: string
@@ -211,7 +218,15 @@
+
Defined in src/pools/abstract-pool.ts:116
+
+Protected
Optional
Readonly
max
+max?: number
+
+
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -219,7 +234,7 @@
+Defined in src/pools/abstract-pool.ts:115
Protected
Readonly
opts
@@ -227,7 +242,7 @@
+Defined in src/pools/abstract-pool.ts:117
Protected
promiseResponseMap
@@ -240,7 +255,7 @@
+Defined in src/pools/abstract-pool.ts:77
Private
Readonly
startTimestamp
startTimestamp: number
@@ -248,7 +263,15 @@
+Defined in src/pools/abstract-pool.ts:105
+
+Private
started
+started: boolean
+
+
Private
Readonly
starting
starting: boolean
@@ -256,7 +279,7 @@
+Defined in src/pools/abstract-pool.ts:97
Protected
workerChoiceStrategyContext
@@ -264,7 +287,7 @@
+Defined in src/pools/abstract-pool.ts:83
Readonly
Internal
workerNodes
@@ -273,7 +296,7 @@
+Defined in src/pools/abstract-pool.ts:64
Protected
full
@@ -299,7 +322,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:694
+Defined in src/pools/abstract-pool.ts:355
-Protected
Abstract
maxSize
+Protected
maxSize
- get maxSize(): number
-
@@ -322,9 +345,9 @@
Returns number
+Defined in src/pools/abstract-pool.ts:567
-Protected
Abstract
minSize
+Protected
minSize
- get minSize(): number
-
@@ -333,7 +356,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:560
Private
ready
@@ -344,7 +367,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:512
Protected
Abstract
type
@@ -356,7 +379,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:550
+Defined in src/pools/abstract-pool.ts:529
Protected
Abstract
worker
@@ -379,7 +402,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:555
Protected
afterTaskExecutionHook
@@ -428,7 +451,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:892
Protected
afterWorkerNodeSetup
@@ -448,7 +471,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1166
Protected
beforeTaskExecutionHook
@@ -473,7 +496,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:862
Private
buildTasksQueueOptions
@@ -486,15 +509,31 @@ Can be overridden.
-
+
+Private
checkAndEmitDynamicWorkerCreationEvents
-- checkAndEmitEvents(): void
+- checkAndEmitDynamicWorkerCreationEvents(): void
-
Returns void
+Defined in src/pools/abstract-pool.ts:1417
+
+Private
checkAndEmitTaskExecutionEvents
+
+- checkAndEmitTaskExecutionEvents(): void
+-
+
Returns void
+
+Private
checkAndEmitTaskQueuingEvents
+
+- checkAndEmitTaskQueuingEvents(): void
+-
+
Returns void
Protected
checkDynamicPoolSize
@@ -509,7 +548,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:186
Private
checkFilePath
@@ -522,7 +561,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:155
Private
checkMessageWorkerId
+Defined in src/pools/abstract-pool.ts:577
Private
checkNumberOfWorkers
@@ -556,7 +595,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:168
Private
checkPoolOptions
@@ -569,7 +608,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:212
Private
checkValidTasksQueueOptions
@@ -579,10 +618,10 @@ Can be overridden.
Parameters
+
Returns void
+Defined in src/pools/abstract-pool.ts:294
Private
checkValidWorkerChoiceStrategy
@@ -595,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:240
Private
checkValidWorkerChoiceStrategyOptions
@@ -608,7 +647,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:250
Private
chooseWorkerNode
@@ -621,7 +660,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1019
Protected
createAndSetupDynamicWorkerNode
@@ -633,7 +672,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1109
Protected
createAndSetupWorkerNode
@@ -645,7 +684,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1065
Protected
Abstract
createWorker
@@ -657,7 +696,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1058
Private
dequeueTask
@@ -670,7 +709,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1508
+Defined in src/pools/abstract-pool.ts:807
Protected
Abstract
destroyWorkerNode
@@ -701,32 +740,32 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:838
enableTasksQueue
- enableTasksQueue(enable, tasksQueueOptions?): void
-
-
-
The worker information.
+The worker information.
+Defined in src/pools/abstract-pool.ts:1431
Private
getWorkerNodeKeyByWorker
@@ -857,7 +896,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:596
Private
getWorkerNodeKeyByWorkerId
@@ -877,7 +916,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:608
Private
handleTaskExecutionResponse
@@ -890,7 +929,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1377
Private
handleWorkerReadyResponse
@@ -903,7 +942,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1363
Private
hasBackPressure
@@ -911,7 +950,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:1481
hasWorkerNodeBackPressure
+Defined in src/pools/abstract-pool.ts:1474
Protected
internalBusy
@@ -944,7 +983,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:710
Protected
Abstract
isMain
@@ -955,7 +994,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:853
+Defined in src/pools/abstract-pool.ts:731
Private
redistributeQueuedTasks
@@ -981,7 +1020,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1206
Protected
Abstract
registerWorkerMessageListener
@@ -1021,7 +1060,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1153
Private
removeWorkerNode
@@ -1040,7 +1079,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1465
Protected
sendKillMessageToWorker
@@ -1055,7 +1094,7 @@ Can be overridden.
workerId: number
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:817
Protected
Abstract
sendStartupMessageToWorker
@@ -1074,7 +1113,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1186
Private
sendStatisticsMessageToWorker
@@ -1093,7 +1132,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1193
Protected
Abstract
sendToWorker
@@ -1122,27 +1161,40 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1047
+
+Private
setTasksQueueMaxSize
+
+- setTasksQueueMaxSize(size): void
+-
+
+
Returns void
setTasksQueueOptions
- setTasksQueueOptions(tasksQueueOptions): void
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:979
Private
updateRunTimeWorkerUsage
@@ -1282,7 +1360,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:952
Private
updateTaskStatisticsWorkerUsage
@@ -1297,7 +1375,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:934
Private
updateWaitTimeWorkerUsage
@@ -1312,7 +1390,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:966
Protected
workerListener
@@ -1339,7 +1417,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1343
Dynamic pool maximum size property placeholder.
+