X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=905e085b6ed963eb2e2a81ee9ea6fc6774756b6f;hb=5543cb1ca8011b99a67fcd5fd3a7a5c2b1c4a85e;hp=aff9850dd46ceb55e6088a5de0ea9e4d8b744410;hpb=31542ddfe8297d3bd0f9cf97a3de06a03dafc15d;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index aff9850d..905e085b 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,13 +1,13 @@
-
AbstractPool | poolifier - v2.6.32
@@ -49,19 +49,19 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:64
- Index
+ Index
Constructors
-constructor
+
Properties
-emitter?
+
Accessors
-busy
+
Constructors
-constructor
+constructor
- new AbstractPool<Worker, Data, Response>(numberOfWorkers, filePath, opts): AbstractPool<Worker, Data, Response>
-
@@ -188,7 +201,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:126
Protected
Readonly
filePath
filePath: string
@@ -217,7 +230,7 @@
+
Defined in src/pools/abstract-pool.ts:128
Protected
Optional
Readonly
max
max?: number
@@ -225,7 +238,7 @@
+
Defined in src/pools/abstract-pool.ts:97
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -233,7 +246,7 @@
+
Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
opts
@@ -241,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
@@ -270,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
@@ -286,7 +311,7 @@
+
Defined in src/pools/abstract-pool.ts:88
Readonly
Internal
workerNodes
@@ -295,7 +320,7 @@
+
Defined in src/pools/abstract-pool.ts:70
Protected
full
@@ -321,7 +346,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:645
+
Defined in src/pools/abstract-pool.ts:265
Protected
maxSize
@@ -344,7 +369,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:478
Protected
minSize
@@ -355,7 +380,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:471
Private
ready
@@ -366,7 +391,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:423
Protected
Abstract
type
@@ -378,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
@@ -401,9 +426,40 @@
Returns "thread" | "cluster"
+
Defined in src/pools/abstract-pool.ts:466
+Defined in src/pools/abstract-pool.ts:1587
Protected
afterTaskExecutionHook
@@ -450,7 +506,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1026
Protected
afterWorkerNodeSetup
@@ -470,7 +526,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1337
Protected
beforeTaskExecutionHook
@@ -495,7 +551,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:996
Private
buildTasksQueueOptions
@@ -508,7 +564,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:594
Private
checkAndEmitDynamicWorkerCreationEvents
@@ -516,7 +572,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1562
Private
checkAndEmitTaskExecutionEvents
@@ -524,7 +580,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1550
Private
checkAndEmitTaskQueuingEvents
@@ -532,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
@@ -594,7 +622,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:170
Private
checkPoolOptions
@@ -607,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
@@ -646,7 +648,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:217
Private
chooseWorkerNode
@@ -659,7 +661,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1153
Protected
createAndSetupDynamicWorkerNode
@@ -671,7 +673,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1243
Protected
createAndSetupWorkerNode
@@ -683,7 +685,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1199
Protected
Abstract
createWorker
@@ -695,7 +697,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1192
+
+Private
deleteTaskFunctionWorkerUsages
+
+- deleteTaskFunctionWorkerUsages(name): void
+-
+
+
Returns void
Private
dequeueTask
@@ -708,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
@@ -739,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
@@ -779,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
@@ -834,7 +889,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1640
Protected
flushTasksQueue
@@ -847,7 +902,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1660
Private
flushTasksQueues
@@ -855,11 +910,11 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1670
Protected
getWorkerInfo
-- getWorkerInfo(workerNodeKey): undefined | WorkerInfo
+- getWorkerInfo(workerNodeKey): WorkerInfo
-
@@ -871,11 +926,11 @@ Can be overridden.
-The worker information.
+The worker information.
+Defined in src/pools/abstract-pool.ts:1576
Private
getWorkerNodeKeyByWorker
@@ -895,7 +950,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:507
Private
getWorkerNodeKeyByWorkerId
@@ -907,7 +962,7 @@ Can be overridden.
Parameters
-
-
workerId: number
+workerId: undefined | number
@@ -915,7 +970,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:519
Private
handleTaskExecutionResponse
@@ -928,7 +983,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1522
Private
handleWorkerReadyResponse
@@ -941,7 +996,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1506
Private
hasBackPressure
@@ -949,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
@@ -982,7 +1058,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:661
Protected
Abstract
isMain
@@ -993,20 +1069,20 @@ Can be overridden.
Returns boolean
-
+
+Defined in src/pools/abstract-pool.ts:829
Private
redistributeQueuedTasks
@@ -1019,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
@@ -1059,7 +1175,28 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1298
+
Private
removeWorkerNode
@@ -1078,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
@@ -1112,7 +1247,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1361
Private
sendStatisticsMessageToWorker
@@ -1131,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
@@ -1160,20 +1323,36 @@ Can be overridden.
Returns void
-
-Private
setTasksQueueMaxSize
-
+
+setDefaultTaskFunction
+
+- setDefaultTaskFunction(name): Promise<boolean>
-
+
+
name: string
+
+
+Returns Promise<boolean>
true
if the default task function was set, false
otherwise.
+
+
+
+Private
setTaskStealing
+
+- setTaskStealing(): void
+-
Returns void
+Defined in src/pools/abstract-pool.ts:614
+Defined in src/pools/abstract-pool.ts:573
+
+Private
setTasksQueueSize
+
+- setTasksQueueSize(size): void
+-
+
+
Returns void
+
+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
@@ -1250,7 +1450,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:980
Private
shallCreateDynamicWorker
@@ -1262,7 +1462,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1170
+
+Private
shallExecuteTask
+
+- shallExecuteTask(workerNodeKey): boolean
+-
+
+
Returns boolean
Private
shallUpdateTaskFunctionWorkerUsage
@@ -1282,15 +1495,32 @@ Can be overridden.
-
+
+start
+
+- start(): void
+-
+
+
Returns void
+
+
+Private
taskStealingOnEmptyQueue
-- startPool(): void
+- taskStealingOnEmptyQueue(workerId): void
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1420
Private
tasksQueueSize
@@ -1303,7 +1533,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1656
Private
tasksStealingOnBackPressure
@@ -1316,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
@@ -1331,7 +1577,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1113
Private
updateRunTimeWorkerUsage
@@ -1346,7 +1592,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1086
Private
updateTaskStatisticsWorkerUsage
@@ -1361,7 +1607,22 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1068
+
+Private
updateTaskStolenStatisticsWorkerUsage
+
+- updateTaskStolenStatisticsWorkerUsage(workerNodeKey, taskName): void
+-
+
+
Parameters
+
+-
+
workerNodeKey: number
+-
+
taskName: string
+Returns void
Private
updateWaitTimeWorkerUsage
@@ -1376,7 +1637,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:1100
Protected
workerListener
@@ -1403,20 +1664,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1488
+
-
\ No newline at end of file
+Generated using TypeDoc
+
\ No newline at end of file
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