X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FAbstractPool.html;h=4f501d6f503d1bdab4b5ab50ca3e7d2d989f409e;hb=0cf6d1374ad842cc31aca1a8ddaa1bc5a9b9302b;hp=1009c580e59f87c0c3e46b503b1a1482cfd9c6e4;hpb=c6e4045f0809e888bfbd1dbfc04fa10b7f93a66e;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 1009c580..4f501d6f 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.7.5
+AbstractPool | poolifier - v3.0.4
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:65
Constructors
@@ -202,7 +203,7 @@
Returns AbstractPool<Worker, Data, Response>
+Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
filePath
filePath: string
@@ -232,7 +233,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:129
Protected
Optional
Readonly
max
max?: number
@@ -240,7 +241,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:79
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -248,7 +249,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:128
Protected
Readonly
opts
@@ -256,7 +257,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:130
Protected
promiseResponseMap
@@ -269,7 +270,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:88
Private
Readonly
startTimestamp
startTimestamp: number
@@ -277,7 +278,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:118
Private
started
started: boolean
@@ -285,7 +286,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:110
Private
starting
starting: boolean
@@ -293,7 +294,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:114
Private
Readonly
taskFunctions
@@ -305,7 +306,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:105
Protected
workerChoiceStrategyContext
@@ -313,7 +314,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:94
Readonly
Internal
workerNodes
@@ -322,7 +323,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:71
Accessors
@@ -336,7 +337,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns boolean
+Defined in src/pools/abstract-pool.ts:668
Protected
full
@@ -348,7 +349,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns boolean
+Defined in src/pools/abstract-pool.ts:659
info
@@ -360,7 +361,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:272
Protected
maxSize
@@ -371,7 +372,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns number
+Defined in src/pools/abstract-pool.ts:485
Protected
minSize
@@ -382,7 +383,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns number
+Defined in src/pools/abstract-pool.ts:478
Private
ready
@@ -393,7 +394,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns boolean
+Defined in src/pools/abstract-pool.ts:430
Protected
Abstract
type
@@ -405,7 +406,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:468
Private
utilization
@@ -417,7 +418,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:447
Protected
Abstract
worker
@@ -428,7 +429,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:473
+Defined in src/pools/abstract-pool.ts:1613
Protected
afterTaskExecutionHook
@@ -508,7 +509,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1041
Protected
afterWorkerNodeSetup
@@ -528,7 +529,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1354
Protected
beforeTaskExecutionHook
@@ -553,7 +554,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1011
Private
buildTasksQueueOptions
@@ -566,7 +567,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:598
Private
checkAndEmitDynamicWorkerCreationEvents
@@ -574,7 +575,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1588
Private
checkAndEmitTaskExecutionEvents
@@ -582,7 +583,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1576
Private
checkAndEmitTaskQueuingEvents
@@ -590,7 +591,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1582
Private
checkMessageWorkerId
+Defined in src/pools/abstract-pool.ts:495
Private
checkNumberOfWorkers
@@ -624,7 +625,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:171
Private
checkPoolOptions
@@ -637,7 +638,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:189
Private
checkValidWorkerChoiceStrategyOptions
@@ -650,7 +651,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:218
Private
chooseWorkerNode
@@ -663,7 +664,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1168
Protected
createAndSetupDynamicWorkerNode
@@ -675,7 +676,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1258
Protected
createAndSetupWorkerNode
@@ -687,7 +688,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1214
Protected
Abstract
createWorker
@@ -699,7 +700,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1207
Private
deleteTaskFunctionWorkerUsages
@@ -712,7 +713,7 @@ Can be overridden.
name: string
Returns void
+Defined in src/pools/abstract-pool.ts:863
Private
dequeueTask
@@ -725,7 +726,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1682
Protected
Abstract
deregisterWorkerMessageListener
@@ -765,7 +766,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1341
+Defined in src/pools/abstract-pool.ts:948
Protected
Abstract
destroyWorkerNode
@@ -796,7 +797,7 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:987
+Defined in src/pools/abstract-pool.ts:563
Private
enqueueTask
@@ -836,7 +837,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1676
+Defined in src/pools/abstract-pool.ts:878
Private
executeTask
@@ -891,7 +892,20 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1670
+
+Protected
flagWorkerNodeAsNotReady
+
+- flagWorkerNodeAsNotReady(workerNodeKey): void
+-
+
+
Returns void
Protected
flushTasksQueue
@@ -904,7 +918,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1690
Private
flushTasksQueues
@@ -912,7 +926,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1700
Protected
getWorkerInfo
@@ -932,7 +946,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1602
Private
getWorkerNodeKeyByWorker
@@ -952,7 +966,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:511
Private
getWorkerNodeKeyByWorkerId
@@ -972,7 +986,33 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:523
+
+Private
Readonly
handleBackPressureEvent
+
+- handleBackPressureEvent(event): void
+-
+
+
Returns void
+
+Private
Readonly
handleEmptyQueueEvent
+
+- handleEmptyQueueEvent(event): void
+-
+
+
Returns void
Private
handleTaskExecutionResponse
@@ -985,7 +1025,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1548
Private
handleWorkerReadyResponse
@@ -998,7 +1038,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1532
Private
hasBackPressure
@@ -1006,7 +1046,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:1655
+Defined in src/pools/abstract-pool.ts:791
hasWorkerNodeBackPressure
+Defined in src/pools/abstract-pool.ts:1648
Private
initializeEventEmitter
@@ -1056,7 +1096,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:265
Protected
internalBusy
@@ -1068,7 +1108,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:675
Protected
Abstract
isMain
@@ -1079,7 +1119,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1002
+Defined in src/pools/abstract-pool.ts:843
Private
redistributeQueuedTasks
@@ -1105,7 +1145,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1404
Protected
Abstract
registerOnceWorkerMessageListener
@@ -1145,7 +1185,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1328
Protected
Abstract
registerWorkerMessageListener
@@ -1185,7 +1225,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1315
+Defined in src/pools/abstract-pool.ts:827
Private
removeWorkerNode
@@ -1225,7 +1265,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1635
Protected
sendKillMessageToWorker
@@ -1238,7 +1278,7 @@ Can be overridden.
workerNodeKey: number
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:959
Protected
Abstract
sendStartupMessageToWorker
@@ -1257,7 +1297,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1385
Private
sendStatisticsMessageToWorker
@@ -1276,7 +1316,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1392
Private
sendTaskFunctionOperationToWorker
@@ -1291,7 +1331,7 @@ Can be overridden.
Returns Promise<boolean>
+Defined in src/pools/abstract-pool.ts:694
Private
sendTaskFunctionOperationToWorkers
@@ -1304,7 +1344,7 @@ Can be overridden.
Returns Promise<boolean>
+Defined in src/pools/abstract-pool.ts:735
Protected
Abstract
sendToWorker
@@ -1333,7 +1373,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1196
+Defined in src/pools/abstract-pool.ts:856
Private
setTaskStealing
@@ -1362,7 +1402,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:618
+Defined in src/pools/abstract-pool.ts:577
Private
setTasksQueueSize
@@ -1395,7 +1435,7 @@ Can be overridden.
size: number
Returns void
+Defined in src/pools/abstract-pool.ts:612
Private
setTasksStealingOnBackPressure
@@ -1403,7 +1443,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:636
+Defined in src/pools/abstract-pool.ts:530
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:549
Protected
setupHook
@@ -1460,7 +1500,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:995
Private
shallCreateDynamicWorker
@@ -1472,7 +1512,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1185
Private
shallExecuteTask
@@ -1485,7 +1525,7 @@ Can be overridden.
workerNodeKey: number
Returns boolean
+Defined in src/pools/abstract-pool.ts:869
Private
shallUpdateTaskFunctionWorkerUsage
@@ -1505,7 +1545,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1074
-
-Private
taskStealingOnEmptyQueue
-
-- taskStealingOnEmptyQueue(workerId): void
--
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:932
Private
tasksQueueSize
@@ -1543,20 +1570,7 @@ Can be overridden.
workerNodeKey: number
Returns number
-
-Private
tasksStealingOnBackPressure
-
-- tasksStealingOnBackPressure(workerId): void
--
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:1686
Private
unsetTaskStealing
@@ -1564,7 +1578,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:627
Private
unsetTasksStealingOnBackPressure
@@ -1572,7 +1586,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:645
Private
updateEluWorkerUsage
@@ -1587,7 +1601,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1128
Private
updateRunTimeWorkerUsage
@@ -1602,7 +1616,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1101
Private
updateTaskStatisticsWorkerUsage
@@ -1617,7 +1631,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1083
Private
updateTaskStolenStatisticsWorkerUsage
@@ -1632,7 +1646,7 @@ Can be overridden.
taskName: string
Returns void
+Defined in src/pools/abstract-pool.ts:1425
Private
updateWaitTimeWorkerUsage
@@ -1647,34 +1661,23 @@ Can be overridden.
task: Task<Data>
Returns void
-
+
+Protected
workerMessageListener
@@ -1742,11 +1745,14 @@ Can be overridden.
enqueueTask
execute
executeTask
+flagWorkerNodeAsNotReady
flushTasksQueue
flushTasksQueues
getWorkerInfo
getWorkerNodeKeyByWorker
getWorkerNodeKeyByWorkerId
+handleBackPressureEvent
+handleEmptyQueueEvent
handleTaskExecutionResponse
handleWorkerReadyResponse
hasBackPressure
@@ -1779,9 +1785,7 @@ Can be overridden.
shallExecuteTask
shallUpdateTaskFunctionWorkerUsage
start
-taskStealingOnEmptyQueue
tasksQueueSize
-tasksStealingOnBackPressure
unsetTaskStealing
unsetTasksStealingOnBackPressure
updateEluWorkerUsage
@@ -1789,9 +1793,9 @@ Can be overridden.
updateTaskStatisticsWorkerUsage
updateTaskStolenStatisticsWorkerUsage
updateWaitTimeWorkerUsage
-workerListener
+workerMessageListener
-
\ No newline at end of file
+
\ No newline at end of file
This method is the listener registered for each worker message.
-