X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=e382e9e16e85fa1b4736e8df9cfd0842e9c02057;hb=3eed67feea0f527e3ee31a6ebb1063883eec3855;hp=e0ce9367d8156b3d8f65f10367f605703ed569ee;hpb=a84c4698b83aaa02b9f10e52aa9c76eff5b5871f;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index e0ce9367..e382e9e1 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,13 +1,13 @@
-
AbstractPool | poolifier - v2.6.35
@@ -49,19 +49,19 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:59
- 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 +195,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:114
Protected
Readonly
filePath
filePath: string
@@ -218,7 +224,7 @@
+
Defined in src/pools/abstract-pool.ts:116
Protected
Optional
Readonly
max
max?: number
@@ -226,7 +232,7 @@
+
Defined in src/pools/abstract-pool.ts:92
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -234,7 +240,7 @@
+
Defined in src/pools/abstract-pool.ts:115
Protected
Readonly
opts
@@ -242,11 +248,11 @@
+Defined in src/pools/abstract-pool.ts:117
Protected
promiseResponseMap
-
+
Defined in src/pools/abstract-pool.ts:105
Private
started
started: boolean
@@ -271,15 +277,15 @@
+
Defined in src/pools/abstract-pool.ts:97
-Private
Readonly
starting
+Private
starting
starting: boolean
+
Defined in src/pools/abstract-pool.ts:101
Protected
workerChoiceStrategyContext
@@ -287,7 +293,7 @@
+
Defined in src/pools/abstract-pool.ts:83
Readonly
Internal
workerNodes
@@ -296,7 +302,7 @@
+
Defined in src/pools/abstract-pool.ts:65
Protected
full
@@ -322,7 +328,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:722
+
Defined in src/pools/abstract-pool.ts:342
Protected
maxSize
@@ -345,7 +351,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:555
Protected
minSize
@@ -356,7 +362,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:548
Private
ready
@@ -367,7 +373,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:500
Protected
Abstract
type
@@ -379,7 +385,7 @@
Returns "fixed" | "dynamic"
+
Defined in src/pools/abstract-pool.ts:538
+
Defined in src/pools/abstract-pool.ts:517
Protected
Abstract
worker
@@ -402,7 +408,7 @@
Returns "thread" | "cluster"
+
Defined in src/pools/abstract-pool.ts:543
+Defined in src/pools/abstract-pool.ts:1469
Protected
afterTaskExecutionHook
@@ -451,7 +457,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:935
Protected
afterWorkerNodeSetup
@@ -471,7 +477,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1209
Protected
beforeTaskExecutionHook
@@ -496,7 +502,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:905
Private
buildTasksQueueOptions
@@ -509,7 +515,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:671
Private
checkAndEmitDynamicWorkerCreationEvents
@@ -517,7 +523,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1444
Private
checkAndEmitTaskExecutionEvents
@@ -525,7 +531,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1432
Private
checkAndEmitTaskQueuingEvents
@@ -533,7 +539,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1438
Protected
checkDynamicPoolSize
@@ -548,7 +554,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:187
Private
checkFilePath
@@ -561,7 +567,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:156
Private
checkMessageWorkerId
+Defined in src/pools/abstract-pool.ts:565
Private
checkNumberOfWorkers
@@ -595,7 +601,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:169
Private
checkPoolOptions
@@ -608,7 +614,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:213
Private
checkValidTasksQueueOptions
@@ -618,10 +624,10 @@ Can be overridden.
Parameters
+
Returns void
+Defined in src/pools/abstract-pool.ts:304
Private
checkValidWorkerChoiceStrategy
@@ -634,7 +640,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:244
Private
checkValidWorkerChoiceStrategyOptions
@@ -647,7 +653,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:257
Private
chooseWorkerNode
@@ -660,7 +666,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1062
Protected
createAndSetupDynamicWorkerNode
@@ -672,7 +678,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1152
Protected
createAndSetupWorkerNode
@@ -684,7 +690,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1108
Protected
Abstract
createWorker
@@ -696,7 +702,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1101
Private
dequeueTask
@@ -709,7 +715,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1534
+Defined in src/pools/abstract-pool.ts:850
Protected
Abstract
destroyWorkerNode
@@ -740,7 +746,7 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:881
+Defined in src/pools/abstract-pool.ts:636
Private
enqueueTask
@@ -780,7 +786,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1528
+Defined in src/pools/abstract-pool.ts:779
Private
executeTask
@@ -835,7 +841,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1522
Protected
flushTasksQueue
@@ -848,7 +854,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1542
Private
flushTasksQueues
@@ -856,11 +862,11 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1552
Protected
getWorkerInfo
-- getWorkerInfo(workerNodeKey): undefined | WorkerInfo
+- getWorkerInfo(workerNodeKey): WorkerInfo
-
@@ -872,11 +878,11 @@ Can be overridden.
-The worker information.
+The worker information.
+Defined in src/pools/abstract-pool.ts:1458
Private
getWorkerNodeKeyByWorker
@@ -896,7 +902,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:584
Private
getWorkerNodeKeyByWorkerId
@@ -916,7 +922,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:596
Private
handleTaskExecutionResponse
@@ -929,7 +935,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1404
Private
handleWorkerReadyResponse
@@ -942,7 +948,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1390
Private
hasBackPressure
@@ -950,7 +956,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:1507
hasWorkerNodeBackPressure
+Defined in src/pools/abstract-pool.ts:1500
Protected
internalBusy
@@ -983,7 +989,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:738
Protected
Abstract
isMain
@@ -994,7 +1000,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:896
+Defined in src/pools/abstract-pool.ts:758
Private
redistributeQueuedTasks
@@ -1020,7 +1026,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1253
Protected
Abstract
registerWorkerMessageListener
@@ -1060,7 +1066,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1196
Private
removeWorkerNode
@@ -1079,7 +1085,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1491
Protected
sendKillMessageToWorker
@@ -1094,7 +1100,7 @@ Can be overridden.
workerId: number
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:860
Protected
Abstract
sendStartupMessageToWorker
@@ -1113,7 +1119,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1233
Private
sendStatisticsMessageToWorker
@@ -1132,7 +1138,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1240
Protected
Abstract
sendToWorker
@@ -1161,20 +1167,15 @@ Can be overridden.
Returns void
-
+
+Private
setTaskStealing
-- setTasksQueueMaxSize(size): void
+- setTaskStealing(): void
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:691
+Defined in src/pools/abstract-pool.ts:650
+
+Private
setTasksQueueSize
+
+- setTasksQueueSize(size): void
+-
+
+
Returns void
+
+Private
setTasksStealingOnBackPressure
+
+- setTasksStealingOnBackPressure(): void
+-
+
Returns void
+Defined in src/pools/abstract-pool.ts:603
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:622
Protected
setupHook
@@ -1251,7 +1273,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:889
Private
shallCreateDynamicWorker
@@ -1263,7 +1285,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1079
+
+Private
shallExecuteTask
+
+- shallExecuteTask(workerNodeKey): boolean
+-
+
+
Returns boolean
Private
shallUpdateTaskFunctionWorkerUsage
@@ -1283,15 +1318,19 @@ Can be overridden.
-
+
+start
+
+- start(): void
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:834
Private
taskStealingOnEmptyQueue
@@ -1304,7 +1343,7 @@ Can be overridden.
workerId: number
Returns void
+Defined in src/pools/abstract-pool.ts:1297
Private
tasksQueueSize
@@ -1317,7 +1356,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1538
Private
tasksStealingOnBackPressure
@@ -1330,7 +1369,23 @@ Can be overridden.
workerId: number
Returns void
+Defined in src/pools/abstract-pool.ts:1329
+
+Private
unsetTaskStealing
+
+- unsetTaskStealing(): void
+-
+
Returns void
+
+Private
unsetTasksStealingOnBackPressure
+
+- unsetTasksStealingOnBackPressure(): void
+-
+
Returns void
Private
updateEluWorkerUsage
@@ -1345,7 +1400,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1022
Private
updateRunTimeWorkerUsage
@@ -1360,7 +1415,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:995
Private
updateTaskStatisticsWorkerUsage
@@ -1375,7 +1430,22 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:977
+
+Private
updateTaskStolenStatisticsWorkerUsage
+
+- updateTaskStolenStatisticsWorkerUsage(workerNodeKey, taskName): void
+-
+
+
Parameters
+
+-
+
workerNodeKey: number
+-
+
taskName: string
+Returns void
Private
updateWaitTimeWorkerUsage
@@ -1390,7 +1460,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:1009
Protected
workerListener
@@ -1417,20 +1487,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1372
+
-
\ 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