X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=30969c24eba5305e5ab3a9f7431500638caca2a7;hb=bfc75ccaf49d915d2b7e73c92360787b3245321a;hp=00d68b3d181866d60a64610ffe52a9cd7260643a;hpb=969223ea18802a84dfea369e254332e11bf8e419;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 00d68b3d..30969c24 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,13 +1,13 @@
-
AbstractPool | poolifier - v2.6.33
@@ -49,19 +49,19 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:60
- Index
+ Index
Constructors
-constructor
+
Properties
-emitter?
+
Accessors
-busy
+
Constructors
-constructor
+constructor
- new AbstractPool<Worker, Data, Response>(numberOfWorkers, filePath, opts): AbstractPool<Worker, Data, Response>
-
@@ -189,7 +203,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:122
Protected
Readonly
filePath
filePath: string
@@ -218,7 +232,7 @@
+
Defined in src/pools/abstract-pool.ts:124
Protected
Optional
Readonly
max
max?: number
@@ -226,7 +240,7 @@
+
Defined in src/pools/abstract-pool.ts:93
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -234,7 +248,7 @@
+
Defined in src/pools/abstract-pool.ts:123
Protected
Readonly
opts
@@ -242,11 +256,11 @@
+Defined in src/pools/abstract-pool.ts:125
Protected
promiseResponseMap
-
+
Defined in src/pools/abstract-pool.ts:113
Private
started
started: boolean
@@ -271,15 +285,27 @@
+
Defined in src/pools/abstract-pool.ts:105
-Private
Readonly
starting
+Private
starting
starting: boolean
+
Defined in src/pools/abstract-pool.ts:109
+
+Private
Readonly
taskFunctions
+
+
+
Protected
workerChoiceStrategyContext
@@ -287,7 +313,7 @@
+
Defined in src/pools/abstract-pool.ts:84
Readonly
Internal
workerNodes
@@ -296,7 +322,7 @@
+
Defined in src/pools/abstract-pool.ts:66
Protected
full
@@ -322,7 +348,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:732
+
Defined in src/pools/abstract-pool.ts:352
Protected
maxSize
@@ -345,7 +371,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:565
Protected
minSize
@@ -356,7 +382,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:558
Private
ready
@@ -367,7 +393,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:510
Protected
Abstract
type
@@ -379,7 +405,7 @@
Returns "fixed" | "dynamic"
+
Defined in src/pools/abstract-pool.ts:548
+
Defined in src/pools/abstract-pool.ts:527
Protected
Abstract
worker
@@ -402,9 +428,40 @@
Returns "thread" | "cluster"
+
Defined in src/pools/abstract-pool.ts:553
+Defined in src/pools/abstract-pool.ts:1624
Protected
afterTaskExecutionHook
@@ -451,7 +508,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1090
Protected
afterWorkerNodeSetup
@@ -471,7 +528,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1374
Protected
beforeTaskExecutionHook
@@ -496,7 +553,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1060
Private
buildTasksQueueOptions
@@ -509,7 +566,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:681
Private
checkAndEmitDynamicWorkerCreationEvents
@@ -517,7 +574,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1599
Private
checkAndEmitTaskExecutionEvents
@@ -525,7 +582,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1587
Private
checkAndEmitTaskQueuingEvents
@@ -533,7 +590,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1593
Protected
checkDynamicPoolSize
@@ -548,7 +605,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:197
Private
checkFilePath
@@ -561,7 +618,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:166
Private
checkMessageWorkerId
+Defined in src/pools/abstract-pool.ts:575
Private
checkNumberOfWorkers
@@ -595,7 +652,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:179
Private
checkPoolOptions
@@ -608,7 +665,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:223
Private
checkValidTasksQueueOptions
@@ -618,10 +675,10 @@ Can be overridden.
Parameters
+
Returns void
+Defined in src/pools/abstract-pool.ts:314
Private
checkValidWorkerChoiceStrategy
@@ -634,7 +691,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:254
Private
checkValidWorkerChoiceStrategyOptions
@@ -647,7 +704,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:267
Private
chooseWorkerNode
@@ -660,7 +717,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1217
Protected
createAndSetupDynamicWorkerNode
@@ -672,7 +729,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1307
Protected
createAndSetupWorkerNode
@@ -684,7 +741,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1263
Protected
Abstract
createWorker
@@ -696,7 +753,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1256
+
+Private
deleteTaskFunctionWorkerUsages
+
+- deleteTaskFunctionWorkerUsages(name): void
+-
+
+
Returns void
Private
dequeueTask
@@ -709,7 +779,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1689
+Defined in src/pools/abstract-pool.ts:1000
Protected
Abstract
destroyWorkerNode
@@ -740,7 +810,7 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:1036
+Defined in src/pools/abstract-pool.ts:646
Private
enqueueTask
@@ -780,7 +850,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1683
+Defined in src/pools/abstract-pool.ts:930
Private
executeTask
@@ -835,7 +905,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1677
Protected
flushTasksQueue
@@ -848,7 +918,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1697
Private
flushTasksQueues
@@ -856,11 +926,11 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1707
Protected
getWorkerInfo
-- getWorkerInfo(workerNodeKey): undefined | WorkerInfo
+- getWorkerInfo(workerNodeKey): WorkerInfo
-
@@ -872,11 +942,11 @@ Can be overridden.
-The worker information.
+The worker information.
+Defined in src/pools/abstract-pool.ts:1613
Private
getWorkerNodeKeyByWorker
@@ -896,7 +966,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:594
Private
getWorkerNodeKeyByWorkerId
@@ -908,7 +978,7 @@ Can be overridden.
Parameters
-
-
workerId: number
+workerId: undefined | number
@@ -916,7 +986,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:606
Private
handleTaskExecutionResponse
@@ -929,7 +999,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1559
Private
handleWorkerReadyResponse
@@ -942,7 +1012,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1543
Private
hasBackPressure
@@ -950,7 +1020,28 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:1662
+
hasWorkerNodeBackPressure
+Defined in src/pools/abstract-pool.ts:1655
Protected
internalBusy
@@ -983,7 +1074,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:748
Protected
Abstract
isMain
@@ -994,20 +1085,20 @@ Can be overridden.
Returns boolean
-
+
+Defined in src/pools/abstract-pool.ts:895
Private
redistributeQueuedTasks
@@ -1020,7 +1111,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1417
Protected
Abstract
registerWorkerMessageListener
@@ -1060,7 +1151,28 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1361
+
Private
removeWorkerNode
@@ -1079,22 +1191,20 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1646
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:1010
Protected
Abstract
sendStartupMessageToWorker
@@ -1113,7 +1223,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1398
Private
sendStatisticsMessageToWorker
@@ -1132,7 +1242,35 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1405
+
+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
@@ -1161,20 +1299,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:701
+Defined in src/pools/abstract-pool.ts:660
+
+Private
setTasksQueueSize
+
+- setTasksQueueSize(size): void
+-
+
+
Returns void
+
+Private
setTasksStealingOnBackPressure
+
+- setTasksStealingOnBackPressure(): void
+-
+
Returns void
+Defined in src/pools/abstract-pool.ts:613
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:632
Protected
setupHook
@@ -1251,7 +1426,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1044
Private
shallCreateDynamicWorker
@@ -1263,7 +1438,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1234
+
+Private
shallExecuteTask
+
+- shallExecuteTask(workerNodeKey): boolean
+-
+
+
Returns boolean
Private
shallUpdateTaskFunctionWorkerUsage
@@ -1283,15 +1471,19 @@ Can be overridden.
-
+
+start
+
+- start(): void
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:984
Private
taskStealingOnEmptyQueue
@@ -1304,7 +1496,7 @@ Can be overridden.
workerId: number
Returns void
+Defined in src/pools/abstract-pool.ts:1457
Private
tasksQueueSize
@@ -1317,7 +1509,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1693
Private
tasksStealingOnBackPressure
@@ -1330,7 +1522,23 @@ Can be overridden.
workerId: number
Returns void
+Defined in src/pools/abstract-pool.ts:1485
+
+Private
unsetTaskStealing
+
+- unsetTaskStealing(): void
+-
+
Returns void
+
+Private
unsetTasksStealingOnBackPressure
+
+- unsetTasksStealingOnBackPressure(): void
+-
+
Returns void
Private
updateEluWorkerUsage
@@ -1345,7 +1553,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1177
Private
updateRunTimeWorkerUsage
@@ -1360,7 +1568,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1150
Private
updateTaskStatisticsWorkerUsage
@@ -1375,7 +1583,22 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1132
+
+Private
updateTaskStolenStatisticsWorkerUsage
+
+- updateTaskStolenStatisticsWorkerUsage(workerNodeKey, taskName): void
+-
+
+
Parameters
+
+-
+
workerNodeKey: number
+-
+
taskName: string
+Returns void
Private
updateWaitTimeWorkerUsage
@@ -1390,7 +1613,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:1164
Protected
workerListener
@@ -1417,20 +1640,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1525
+
-
\ 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