X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=00d68b3d181866d60a64610ffe52a9cd7260643a;hb=969223ea18802a84dfea369e254332e11bf8e419;hp=8b279fef929856d2c4c298f1a55104b348cb44ad;hpb=ff6cf64964e78aafa95098852ec0472b567f7b1b;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 8b279fef..00d68b3d 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.26
+AbstractPool | poolifier - v2.6.33
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:57
@@ -63,12 +63,13 @@
Properties
@@ -91,7 +92,9 @@
afterWorkerNodeSetup
beforeTaskExecutionHook
buildTasksQueueOptions
-checkAndEmitEvents
+checkAndEmitDynamicWorkerCreationEvents
+checkAndEmitTaskExecutionEvents
+checkAndEmitTaskQueuingEvents
checkDynamicPoolSize
checkFilePath
checkMessageWorkerId
@@ -118,6 +121,8 @@
getWorkerNodeKeyByWorkerId
handleTaskExecutionResponse
handleWorkerReadyResponse
+hasBackPressure
+hasWorkerNodeBackPressure
internalBusy
isMain
listTaskFunctions
@@ -128,13 +133,17 @@
sendStartupMessageToWorker
sendStatisticsMessageToWorker
sendToWorker
+setTasksQueueMaxSize
setTasksQueueOptions
setWorkerChoiceStrategy
setWorkerChoiceStrategyOptions
setupHook
shallCreateDynamicWorker
+shallUpdateTaskFunctionWorkerUsage
startPool
+taskStealingOnEmptyQueue
tasksQueueSize
+tasksStealingOnBackPressure
updateEluWorkerUsage
updateRunTimeWorkerUsage
updateTaskStatisticsWorkerUsage
@@ -180,7 +189,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:113
Protected
Readonly
filePath
filePath: string
@@ -207,7 +218,15 @@
+
Defined in src/pools/abstract-pool.ts:115
+
+Protected
Optional
Readonly
max
+max?: number
+
+
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -215,7 +234,7 @@
+Defined in src/pools/abstract-pool.ts:114
Protected
Readonly
opts
@@ -223,7 +242,7 @@
+Defined in src/pools/abstract-pool.ts:116
Protected
promiseResponseMap
@@ -236,7 +255,7 @@
+Defined in src/pools/abstract-pool.ts:76
Private
Readonly
startTimestamp
startTimestamp: number
@@ -244,7 +263,15 @@
+Defined in src/pools/abstract-pool.ts:104
+
+Private
started
+started: boolean
+
+
Private
Readonly
starting
starting: boolean
@@ -252,15 +279,7 @@
-
-Private
taskFunctions
-taskFunctions: string[]
-
-
+Defined in src/pools/abstract-pool.ts:96
Protected
workerChoiceStrategyContext
@@ -268,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
@@ -303,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
-
@@ -326,9 +345,9 @@
Returns number
+Defined in src/pools/abstract-pool.ts:555
-Protected
Abstract
minSize
+Protected
minSize
- get minSize(): number
-
@@ -337,7 +356,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:548
Private
ready
@@ -348,7 +367,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:500
Protected
Abstract
type
@@ -360,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
@@ -383,7 +402,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:543
Protected
afterTaskExecutionHook
@@ -432,7 +451,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:879
Protected
afterWorkerNodeSetup
@@ -452,7 +471,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1151
Protected
beforeTaskExecutionHook
@@ -477,7 +496,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:849
Private
buildTasksQueueOptions
@@ -490,15 +509,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:1370
Protected
checkDynamicPoolSize
@@ -513,7 +548,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:185
Private
checkFilePath
@@ -526,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
@@ -560,7 +595,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:167
Private
checkPoolOptions
@@ -573,7 +608,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:211
Private
checkValidTasksQueueOptions
@@ -583,10 +618,10 @@ Can be overridden.
Parameters
+
Returns void
+Defined in src/pools/abstract-pool.ts:293
Private
checkValidWorkerChoiceStrategy
@@ -599,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
@@ -612,7 +647,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:249
Private
chooseWorkerNode
@@ -625,7 +660,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1004
Protected
createAndSetupDynamicWorkerNode
@@ -637,7 +672,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1094
Protected
createAndSetupWorkerNode
@@ -649,7 +684,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1050
Protected
Abstract
createWorker
@@ -661,7 +696,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1043
Private
dequeueTask
@@ -674,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
@@ -705,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
@@ -861,7 +896,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:584
Private
getWorkerNodeKeyByWorkerId
@@ -881,7 +916,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:596
Private
handleTaskExecutionResponse
@@ -894,7 +929,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1336
Private
handleWorkerReadyResponse
@@ -907,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
@@ -919,7 +983,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:698
Protected
Abstract
isMain
@@ -930,7 +994,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:840
+Defined in src/pools/abstract-pool.ts:719
Private
redistributeQueuedTasks
@@ -956,7 +1020,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1191
Protected
Abstract
registerWorkerMessageListener
@@ -996,7 +1060,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1138
Private
removeWorkerNode
@@ -1015,7 +1079,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1424
Protected
sendKillMessageToWorker
@@ -1030,7 +1094,7 @@ Can be overridden.
workerId: number
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:804
Protected
Abstract
sendStartupMessageToWorker
@@ -1049,7 +1113,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1171
Private
sendStatisticsMessageToWorker
@@ -1068,7 +1132,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1178
Protected
Abstract
sendToWorker
@@ -1097,27 +1161,40 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1032
+
+Private
setTasksQueueMaxSize
+
+- setTasksQueueMaxSize(size): void
+-
+
+
Returns void
setTasksQueueOptions
- setTasksQueueOptions(tasksQueueOptions): void
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:965
Private
updateRunTimeWorkerUsage
@@ -1237,7 +1360,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:939
Private
updateTaskStatisticsWorkerUsage
@@ -1252,7 +1375,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:921
Private
updateWaitTimeWorkerUsage
@@ -1267,7 +1390,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:951
Protected
workerListener
@@ -1294,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).