X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=e0ce9367d8156b3d8f65f10367f605703ed569ee;hb=26fb3c18b678a1daab6b18a351a238fb5a3ed5df;hp=22404f94128b9da75cebadc0a110390c1c442f0e;hpb=f2d2c4a40a1d1652ba5fb0dee4b6aa3387321c92;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 22404f94..e0ce9367 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.34
+AbstractPool | poolifier - v2.6.35
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:58
@@ -189,7 +189,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:114
Properties
@@ -201,7 +201,7 @@
'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 >= maximum queue size).
@@ -210,7 +210,7 @@
+Defined in src/pools/abstract-pool.ts:67
Protected
Readonly
filePath
filePath: string
@@ -218,7 +218,7 @@
+
Defined in src/pools/abstract-pool.ts:116
Protected
Optional
Readonly
max
max?: number
@@ -226,7 +226,7 @@
+Defined in src/pools/abstract-pool.ts:92
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -234,7 +234,7 @@
+Defined in src/pools/abstract-pool.ts:115
Protected
Readonly
opts
@@ -242,7 +242,7 @@
+Defined in src/pools/abstract-pool.ts:117
Protected
promiseResponseMap
@@ -255,7 +255,7 @@
+Defined in src/pools/abstract-pool.ts:77
Private
Readonly
startTimestamp
startTimestamp: number
@@ -263,7 +263,7 @@
+Defined in src/pools/abstract-pool.ts:105
Private
started
started: boolean
@@ -271,7 +271,7 @@
+Defined in src/pools/abstract-pool.ts:101
Private
Readonly
starting
starting: boolean
@@ -279,7 +279,7 @@
+Defined in src/pools/abstract-pool.ts:97
Protected
workerChoiceStrategyContext
@@ -287,7 +287,7 @@
+Defined in src/pools/abstract-pool.ts:83
Readonly
Internal
workerNodes
@@ -296,7 +296,7 @@
+Defined in src/pools/abstract-pool.ts:64
Protected
full
@@ -322,7 +322,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:694
+Defined in src/pools/abstract-pool.ts:355
Protected
maxSize
@@ -345,7 +345,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:567
Protected
minSize
@@ -356,7 +356,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:560
Private
ready
@@ -367,7 +367,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:512
Protected
Abstract
type
@@ -379,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
@@ -402,7 +402,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:555
Protected
afterTaskExecutionHook
@@ -451,7 +451,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:892
Protected
afterWorkerNodeSetup
@@ -471,7 +471,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1166
Protected
beforeTaskExecutionHook
@@ -496,7 +496,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:862
Private
buildTasksQueueOptions
@@ -509,7 +509,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:677
Private
checkAndEmitDynamicWorkerCreationEvents
@@ -517,7 +517,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1417
Private
checkAndEmitTaskExecutionEvents
@@ -525,7 +525,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1405
Private
checkAndEmitTaskQueuingEvents
@@ -533,7 +533,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1411
Protected
checkDynamicPoolSize
@@ -548,7 +548,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:186
Private
checkFilePath
@@ -561,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
@@ -595,7 +595,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:168
Private
checkPoolOptions
@@ -608,7 +608,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:212
Private
checkValidTasksQueueOptions
@@ -621,7 +621,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:294
Private
checkValidWorkerChoiceStrategy
@@ -634,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
@@ -647,7 +647,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:250
Private
chooseWorkerNode
@@ -660,7 +660,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1019
Protected
createAndSetupDynamicWorkerNode
@@ -672,7 +672,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1109
Protected
createAndSetupWorkerNode
@@ -684,7 +684,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1065
Protected
Abstract
createWorker
@@ -696,7 +696,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1058
Private
dequeueTask
@@ -709,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
@@ -740,7 +740,7 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:838
+Defined in src/pools/abstract-pool.ts:648
Private
enqueueTask
@@ -780,7 +780,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1502
+Defined in src/pools/abstract-pool.ts:744
Private
executeTask
@@ -835,7 +835,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1496
Protected
flushTasksQueue
@@ -848,7 +848,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1516
Private
flushTasksQueues
@@ -856,7 +856,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1526
Protected
getWorkerInfo
@@ -876,7 +876,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1431
Private
getWorkerNodeKeyByWorker
@@ -896,7 +896,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:596
Private
getWorkerNodeKeyByWorkerId
@@ -916,7 +916,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:608
Private
handleTaskExecutionResponse
@@ -929,7 +929,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1377
Private
handleWorkerReadyResponse
@@ -942,7 +942,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1363
Private
hasBackPressure
@@ -950,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
@@ -983,7 +983,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:710
Protected
Abstract
isMain
@@ -994,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
@@ -1020,7 +1020,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1206
Protected
Abstract
registerWorkerMessageListener
@@ -1060,7 +1060,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1153
Private
removeWorkerNode
@@ -1079,7 +1079,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1465
Protected
sendKillMessageToWorker
@@ -1094,7 +1094,7 @@ Can be overridden.
workerId: number
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:817
Protected
Abstract
sendStartupMessageToWorker
@@ -1113,7 +1113,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1186
Private
sendStatisticsMessageToWorker
@@ -1132,7 +1132,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1193
Protected
Abstract
sendToWorker
@@ -1161,7 +1161,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1047
Private
setTasksQueueMaxSize
@@ -1174,7 +1174,7 @@ Can be overridden.
size: number
Returns void
+Defined in src/pools/abstract-pool.ts:671
+Defined in src/pools/abstract-pool.ts:660
+Defined in src/pools/abstract-pool.ts:615
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:634
Protected
setupHook
@@ -1251,7 +1251,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:846
Private
shallCreateDynamicWorker
@@ -1263,7 +1263,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1036
Private
shallUpdateTaskFunctionWorkerUsage
@@ -1283,7 +1283,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:925
Private
startPool
@@ -1291,7 +1291,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:342
Private
taskStealingOnEmptyQueue
@@ -1304,7 +1304,7 @@ Can be overridden.
workerId: number
Returns void
+Defined in src/pools/abstract-pool.ts:1241
Private
tasksQueueSize
@@ -1317,7 +1317,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1512
Private
tasksStealingOnBackPressure
@@ -1330,7 +1330,7 @@ Can be overridden.
workerId: number
Returns void
+Defined in src/pools/abstract-pool.ts:1292
Private
updateEluWorkerUsage
@@ -1345,7 +1345,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:979
Private
updateRunTimeWorkerUsage
@@ -1360,7 +1360,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:952
Private
updateTaskStatisticsWorkerUsage
@@ -1375,7 +1375,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:934
Private
updateWaitTimeWorkerUsage
@@ -1390,7 +1390,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:966
Protected
workerListener
@@ -1417,7 +1417,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1343