X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=905e085b6ed963eb2e2a81ee9ea6fc6774756b6f;hb=5543cb1ca8011b99a67fcd5fd3a7a5c2b1c4a85e;hp=e306ebe9c5021637043ffb8fb5f345c46cc09b4e;hpb=e905ea64c054a25ef73885e41fc063279bc599ca;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index e306ebe9..905e085b 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.6.44
+AbstractPool | poolifier - v2.7.1
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:64
@@ -87,7 +88,8 @@
Methods
-addWorkerNode
+
addTaskFunction
+
addWorkerNode
afterTaskExecutionHook
afterWorkerNodeSetup
beforeTaskExecutionHook
@@ -95,19 +97,17 @@
checkAndEmitDynamicWorkerCreationEvents
checkAndEmitTaskExecutionEvents
checkAndEmitTaskQueuingEvents
-
checkDynamicPoolSize
-
checkFilePath
checkMessageWorkerId
checkNumberOfWorkers
checkPoolOptions
-
checkValidTasksQueueOptions
-
checkValidWorkerChoiceStrategy
checkValidWorkerChoiceStrategyOptions
chooseWorkerNode
createAndSetupDynamicWorkerNode
createAndSetupWorkerNode
createWorker
+
deleteTaskFunctionWorkerUsages
dequeueTask
+
deregisterWorkerMessageListener
destroy
destroyWorkerNode
enableTasksQueue
@@ -122,29 +122,39 @@
handleTaskExecutionResponse
handleWorkerReadyResponse
hasBackPressure
+
hasTaskFunction
hasWorkerNodeBackPressure
internalBusy
isMain
-
listTaskFunctions
+
listTaskFunctionNames
redistributeQueuedTasks
+
registerOnceWorkerMessageListener
registerWorkerMessageListener
+
removeTaskFunction
removeWorkerNode
sendKillMessageToWorker
sendStartupMessageToWorker
sendStatisticsMessageToWorker
+
sendTaskFunctionOperationToWorker
+
sendTaskFunctionOperationToWorkers
sendToWorker
+
setDefaultTaskFunction
+
setTaskStealing
setTasksQueueOptions
setTasksQueueSize
+
setTasksStealingOnBackPressure
setWorkerChoiceStrategy
setWorkerChoiceStrategyOptions
setupHook
shallCreateDynamicWorker
shallExecuteTask
shallUpdateTaskFunctionWorkerUsage
-
startPool
+
start
taskStealingOnEmptyQueue
tasksQueueSize
tasksStealingOnBackPressure
+
unsetTaskStealing
+
unsetTasksStealingOnBackPressure
updateEluWorkerUsage
updateRunTimeWorkerUsage
updateTaskStatisticsWorkerUsage
@@ -191,7 +201,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:126
Protected
Readonly
filePath
filePath: string
@@ -220,7 +230,7 @@
+
Defined in src/pools/abstract-pool.ts:128
Protected
Optional
Readonly
max
max?: number
@@ -228,7 +238,7 @@
+Defined in src/pools/abstract-pool.ts:97
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -236,7 +246,7 @@
+Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
opts
@@ -244,11 +254,11 @@
+Defined in src/pools/abstract-pool.ts:129
Protected
promiseResponseMap
-
+Defined in src/pools/abstract-pool.ts:117
Private
started
started: boolean
@@ -273,15 +283,27 @@
+Defined in src/pools/abstract-pool.ts:109
-Private
Readonly
starting
+Private
starting
starting: boolean
+Defined in src/pools/abstract-pool.ts:113
+
+Private
Readonly
taskFunctions
+
+
+
Protected
workerChoiceStrategyContext
@@ -289,7 +311,7 @@
+Defined in src/pools/abstract-pool.ts:88
Readonly
Internal
workerNodes
@@ -298,7 +320,7 @@
+Defined in src/pools/abstract-pool.ts:70
Protected
full
@@ -324,7 +346,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:645
+Defined in src/pools/abstract-pool.ts:265
Protected
maxSize
@@ -347,7 +369,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:478
Protected
minSize
@@ -358,7 +380,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:471
Private
ready
@@ -369,7 +391,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:423
Protected
Abstract
type
@@ -381,7 +403,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:461
+Defined in src/pools/abstract-pool.ts:440
Protected
Abstract
worker
@@ -404,9 +426,40 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:466
Protected
afterTaskExecutionHook
@@ -453,7 +506,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1026
Protected
afterWorkerNodeSetup
@@ -473,7 +526,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1337
Protected
beforeTaskExecutionHook
@@ -498,7 +551,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:996
Private
buildTasksQueueOptions
@@ -511,7 +564,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:594
Private
checkAndEmitDynamicWorkerCreationEvents
@@ -519,7 +572,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1562
Private
checkAndEmitTaskExecutionEvents
@@ -527,7 +580,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1550
Private
checkAndEmitTaskQueuingEvents
@@ -535,35 +588,7 @@ Can be overridden.
-
Returns void
-
-Protected
checkDynamicPoolSize
-
-- checkDynamicPoolSize(min, max): void
--
-
-
Parameters
-
--
-
min: number
--
-
max: number
-Returns void
-
-Private
checkFilePath
-
-- checkFilePath(filePath): void
--
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:1556
Private
checkMessageWorkerId
+Defined in src/pools/abstract-pool.ts:488
Private
checkNumberOfWorkers
@@ -597,7 +622,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:170
Private
checkPoolOptions
@@ -610,33 +635,7 @@ Can be overridden.
Returns void
-
-Private
checkValidTasksQueueOptions
-
-- checkValidTasksQueueOptions(tasksQueueOptions): void
--
-
-
Returns void
-
-Private
checkValidWorkerChoiceStrategy
-
-- checkValidWorkerChoiceStrategy(workerChoiceStrategy): void
--
-
-
Parameters
-
--
-
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:188
Private
checkValidWorkerChoiceStrategyOptions
@@ -649,7 +648,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:217
Private
chooseWorkerNode
@@ -662,7 +661,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1153
Protected
createAndSetupDynamicWorkerNode
@@ -674,7 +673,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1243
Protected
createAndSetupWorkerNode
@@ -686,7 +685,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1199
Protected
Abstract
createWorker
@@ -698,7 +697,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1192
+
+Private
deleteTaskFunctionWorkerUsages
+
+- deleteTaskFunctionWorkerUsages(name): void
+-
+
+
Returns void
Private
dequeueTask
@@ -711,7 +723,47 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1652
+
+Protected
Abstract
deregisterWorkerMessageListener
+
+- deregisterWorkerMessageListener<Message>(workerNodeKey, listener): void
+-
+
+
+
+
Parameters
+
+-
+
workerNodeKey: number
+
+
+-
+
listener: ((message) => void)
+
+
+
+-
+
+- (message): void
+-
+
+
Returns void
+Returns void
+
+Defined in src/pools/abstract-pool.ts:934
Protected
Abstract
destroyWorkerNode
@@ -742,7 +794,7 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:972
+Defined in src/pools/abstract-pool.ts:559
Private
enqueueTask
@@ -782,7 +834,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1646
+Defined in src/pools/abstract-pool.ts:864
Private
executeTask
@@ -837,7 +889,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1640
Protected
flushTasksQueue
@@ -850,7 +902,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1660
Private
flushTasksQueues
@@ -858,7 +910,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1670
Protected
getWorkerInfo
@@ -878,7 +930,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1576
Private
getWorkerNodeKeyByWorker
@@ -898,7 +950,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:507
Private
getWorkerNodeKeyByWorkerId
@@ -910,7 +962,7 @@ Can be overridden.
Parameters
-
-
workerId: number
+workerId: undefined | number
@@ -918,7 +970,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:519
Private
handleTaskExecutionResponse
@@ -931,7 +983,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1522
Private
handleWorkerReadyResponse
@@ -944,7 +996,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1506
Private
hasBackPressure
@@ -952,7 +1004,28 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:1625
+
hasWorkerNodeBackPressure
+Defined in src/pools/abstract-pool.ts:1618
Protected
internalBusy
@@ -985,7 +1058,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:661
Protected
Abstract
isMain
@@ -996,20 +1069,20 @@ Can be overridden.
Returns boolean
-
+
+Defined in src/pools/abstract-pool.ts:829
Private
redistributeQueuedTasks
@@ -1022,7 +1095,47 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1380
+
+Protected
Abstract
registerOnceWorkerMessageListener
+
+- registerOnceWorkerMessageListener<Message>(workerNodeKey, listener): void
+-
+
+
+
+
Parameters
+
+-
+
workerNodeKey: number
+
+
+-
+
listener: ((message) => void)
+
+
+
+-
+
+- (message): void
+-
+
+
Returns void
+Returns void
+
Protected
Abstract
registerWorkerMessageListener
@@ -1062,7 +1175,28 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1298
+
Private
removeWorkerNode
@@ -1081,22 +1215,20 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1609
Protected
sendKillMessageToWorker
-- sendKillMessageToWorker(workerNodeKey, workerId): Promise<void>
+- sendKillMessageToWorker(workerNodeKey): Promise<void>
-
Parameters
-
-
workerNodeKey: number
--
-
workerId: number
+workerNodeKey: number
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:944
Protected
Abstract
sendStartupMessageToWorker
@@ -1115,7 +1247,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1361
Private
sendStatisticsMessageToWorker
@@ -1134,7 +1266,35 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1368
+
+Private
sendTaskFunctionOperationToWorker
+
+- sendTaskFunctionOperationToWorker(workerNodeKey, message): Promise<boolean>
+-
+
+
Parameters
+
+-
+
workerNodeKey: number
+-
+
+Returns Promise<boolean>
+
+Private
sendTaskFunctionOperationToWorkers
+
+- sendTaskFunctionOperationToWorkers(message): Promise<boolean>
+-
+
+
Returns Promise<boolean>
Protected
Abstract
sendToWorker
@@ -1163,7 +1323,36 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1181
+
+setDefaultTaskFunction
+
+
+Private
setTaskStealing
+
+- setTaskStealing(): void
+-
+
Returns void
+Defined in src/pools/abstract-pool.ts:573
Private
setTasksQueueSize
@@ -1196,7 +1385,15 @@ Can be overridden.
size: number
Returns void
+Defined in src/pools/abstract-pool.ts:608
+
+Private
setTasksStealingOnBackPressure
+
+- setTasksStealingOnBackPressure(): void
+-
+
Returns void
+Defined in src/pools/abstract-pool.ts:526
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:545
Protected
setupHook
@@ -1253,7 +1450,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:980
Private
shallCreateDynamicWorker
@@ -1265,7 +1462,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1170
Private
shallExecuteTask
@@ -1278,7 +1475,7 @@ Can be overridden.
workerNodeKey: number
Returns boolean
+Defined in src/pools/abstract-pool.ts:855
Private
shallUpdateTaskFunctionWorkerUsage
@@ -1298,15 +1495,19 @@ Can be overridden.
-
+
+start
+
+- start(): void
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:918
Private
taskStealingOnEmptyQueue
@@ -1319,7 +1520,7 @@ Can be overridden.
workerId: number
Returns void
+Defined in src/pools/abstract-pool.ts:1420
Private
tasksQueueSize
@@ -1332,7 +1533,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1656
Private
tasksStealingOnBackPressure
@@ -1345,7 +1546,23 @@ Can be overridden.
workerId: number
Returns void
+Defined in src/pools/abstract-pool.ts:1448
+
+Private
unsetTaskStealing
+
+- unsetTaskStealing(): void
+-
+
Returns void
+
+Private
unsetTasksStealingOnBackPressure
+
+- unsetTasksStealingOnBackPressure(): void
+-
+
Returns void
Private
updateEluWorkerUsage
@@ -1360,7 +1577,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1113
Private
updateRunTimeWorkerUsage
@@ -1375,7 +1592,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1086
Private
updateTaskStatisticsWorkerUsage
@@ -1390,7 +1607,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1068
Private
updateTaskStolenStatisticsWorkerUsage
@@ -1405,7 +1622,7 @@ Can be overridden.
taskName: string
Returns void
+Defined in src/pools/abstract-pool.ts:1401
Private
updateWaitTimeWorkerUsage
@@ -1420,7 +1637,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:1100
Protected
workerListener
@@ -1447,7 +1664,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1488
The task execution response promise map.
+The task execution response promise map:
key
: The message id of each submitted task.value
: An object that contains the worker, the execution response promise resolve and reject callbacks.Private
Readonly
start