X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=e306ebe9c5021637043ffb8fb5f345c46cc09b4e;hb=4e1212db1d198963828820471bde6902277d0388;hp=aff9850dd46ceb55e6088a5de0ea9e4d8b744410;hpb=c74b6981dbc78aa19a73c690eace221969bb997f;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index aff9850d..e306ebe9 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:59
- 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 +191,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:115
Protected
Readonly
filePath
filePath: string
@@ -217,7 +220,7 @@
+
Defined in src/pools/abstract-pool.ts:117
Protected
Optional
Readonly
max
max?: number
@@ -225,7 +228,7 @@
+
Defined in src/pools/abstract-pool.ts:93
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -233,7 +236,7 @@
+
Defined in src/pools/abstract-pool.ts:116
Protected
Readonly
opts
@@ -241,7 +244,7 @@
+Defined in src/pools/abstract-pool.ts:118
Protected
promiseResponseMap
@@ -254,7 +257,7 @@
+
Defined in src/pools/abstract-pool.ts:78
Private
Readonly
startTimestamp
startTimestamp: number
@@ -262,7 +265,7 @@
+
Defined in src/pools/abstract-pool.ts:106
Private
started
started: boolean
@@ -270,7 +273,7 @@
+Defined in src/pools/abstract-pool.ts:102
Private
Readonly
starting
starting: boolean
@@ -278,7 +281,7 @@
+Defined in src/pools/abstract-pool.ts:98
Protected
workerChoiceStrategyContext
@@ -286,7 +289,7 @@
+Defined in src/pools/abstract-pool.ts:84
Readonly
Internal
workerNodes
@@ -295,7 +298,7 @@
+Defined in src/pools/abstract-pool.ts:65
Protected
full
@@ -321,7 +324,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:689
+Defined in src/pools/abstract-pool.ts:350
Protected
maxSize
@@ -344,7 +347,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:562
Protected
minSize
@@ -355,7 +358,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:555
Private
ready
@@ -366,7 +369,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:507
Protected
Abstract
type
@@ -378,7 +381,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:545
+Defined in src/pools/abstract-pool.ts:524
Protected
Abstract
worker
@@ -401,7 +404,7 @@
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:550
Protected
afterTaskExecutionHook
@@ -450,7 +453,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:888
Protected
afterWorkerNodeSetup
@@ -470,7 +473,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1162
Protected
beforeTaskExecutionHook
@@ -495,7 +498,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:858
Private
buildTasksQueueOptions
@@ -508,7 +511,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:672
Private
checkAndEmitDynamicWorkerCreationEvents
@@ -516,7 +519,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1393
Private
checkAndEmitTaskExecutionEvents
@@ -524,7 +527,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1381
Private
checkAndEmitTaskQueuingEvents
@@ -532,7 +535,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1387
Protected
checkDynamicPoolSize
@@ -547,7 +550,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:187
Private
checkFilePath
@@ -560,7 +563,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:572
Private
checkNumberOfWorkers
@@ -594,7 +597,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:169
Private
checkPoolOptions
@@ -607,7 +610,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:213
Private
checkValidTasksQueueOptions
@@ -620,7 +623,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:295
Private
checkValidWorkerChoiceStrategy
@@ -633,7 +636,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:241
Private
checkValidWorkerChoiceStrategyOptions
@@ -646,7 +649,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:251
Private
chooseWorkerNode
@@ -659,7 +662,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1015
Protected
createAndSetupDynamicWorkerNode
@@ -671,7 +674,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1105
Protected
createAndSetupWorkerNode
@@ -683,7 +686,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1061
Protected
Abstract
createWorker
@@ -695,7 +698,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1054
Private
dequeueTask
@@ -708,7 +711,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1483
+Defined in src/pools/abstract-pool.ts:803
Protected
Abstract
destroyWorkerNode
@@ -739,7 +742,7 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:834
+Defined in src/pools/abstract-pool.ts:643
Private
enqueueTask
@@ -779,7 +782,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1477
+Defined in src/pools/abstract-pool.ts:747
Private
executeTask
@@ -834,7 +837,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1471
Protected
flushTasksQueue
@@ -847,7 +850,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1491
Private
flushTasksQueues
@@ -855,11 +858,11 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1501
Protected
getWorkerInfo
-- getWorkerInfo(workerNodeKey): undefined | WorkerInfo
+- getWorkerInfo(workerNodeKey): WorkerInfo
-
@@ -871,11 +874,11 @@ Can be overridden.
-The worker information.
+The worker information.
+Defined in src/pools/abstract-pool.ts:1407
Private
getWorkerNodeKeyByWorker
@@ -895,7 +898,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:591
Private
getWorkerNodeKeyByWorkerId
@@ -915,7 +918,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:603
Private
handleTaskExecutionResponse
@@ -928,7 +931,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1353
Private
handleWorkerReadyResponse
@@ -941,7 +944,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1339
Private
hasBackPressure
@@ -949,7 +952,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:1456
hasWorkerNodeBackPressure
+Defined in src/pools/abstract-pool.ts:1449
Protected
internalBusy
@@ -982,7 +985,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:705
Protected
Abstract
isMain
@@ -993,7 +996,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:849
+Defined in src/pools/abstract-pool.ts:726
Private
redistributeQueuedTasks
@@ -1019,7 +1022,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1202
Protected
Abstract
registerWorkerMessageListener
@@ -1059,7 +1062,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1149
Private
removeWorkerNode
@@ -1078,7 +1081,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1440
Protected
sendKillMessageToWorker
@@ -1093,7 +1096,7 @@ Can be overridden.
workerId: number
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:813
Protected
Abstract
sendStartupMessageToWorker
@@ -1112,7 +1115,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1182
Private
sendStatisticsMessageToWorker
@@ -1131,7 +1134,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1189
Protected
Abstract
sendToWorker
@@ -1160,20 +1163,7 @@ Can be overridden.
Returns void
-
-Private
setTasksQueueMaxSize
-
-- setTasksQueueMaxSize(queueMaxSize): void
--
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:1043
+Defined in src/pools/abstract-pool.ts:655
+
+Private
setTasksQueueSize
+
+- setTasksQueueSize(size): void
+-
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:610
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:629
Protected
setupHook
@@ -1250,7 +1253,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:842
Private
shallCreateDynamicWorker
@@ -1262,7 +1265,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1032
+
+Private
shallExecuteTask
+
+- shallExecuteTask(workerNodeKey): boolean
+-
+
+
Returns boolean
Private
shallUpdateTaskFunctionWorkerUsage
@@ -1282,7 +1298,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:921
Private
startPool
@@ -1290,7 +1306,20 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:337
+
+Private
taskStealingOnEmptyQueue
+
+- taskStealingOnEmptyQueue(workerId): void
+-
+
+
Returns void
Private
tasksQueueSize
@@ -1303,7 +1332,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1487
Private
tasksStealingOnBackPressure
@@ -1316,7 +1345,7 @@ Can be overridden.
workerId: number
Returns void
+Defined in src/pools/abstract-pool.ts:1278
Private
updateEluWorkerUsage
@@ -1331,7 +1360,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:975
Private
updateRunTimeWorkerUsage
@@ -1346,7 +1375,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:948
Private
updateTaskStatisticsWorkerUsage
@@ -1361,7 +1390,22 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:930
+
+Private
updateTaskStolenStatisticsWorkerUsage
+
+- updateTaskStolenStatisticsWorkerUsage(workerNodeKey, taskName): void
+-
+
+
Parameters
+
+-
+
workerNodeKey: number
+-
+
taskName: string
+Returns void
Private
updateWaitTimeWorkerUsage
@@ -1376,7 +1420,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:962
Protected
workerListener
@@ -1403,20 +1447,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1321
+
-
\ No newline at end of file
+Generated using TypeDoc
+
\ No newline at end of file
Gets the worker information given its worker node key.