X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=217b08b93b6be53eca47f8be7883e186713b744d;hb=18fea9f10a9d1fd8bbbc4738284939868faa0db5;hp=e8cc3a662e487f686efd3050b14055fb144b025a;hpb=1c277f5889dcbfed65ca1862efba68198dcaa99c;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index e8cc3a66..217b08b9 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier
+AbstractPool | poolifier - v2.6.8
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:51
+
Defined in src/pools/abstract-pool.ts:96
Protected
Readonly
filePath
filePath: string
@@ -200,7 +202,7 @@
+
Defined in src/pools/abstract-pool.ts:98
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -208,7 +210,7 @@
+Defined in src/pools/abstract-pool.ts:97
Protected
Readonly
opts
@@ -216,7 +218,7 @@
+Defined in src/pools/abstract-pool.ts:99
Protected
promiseResponseMap
@@ -229,7 +231,7 @@
+Defined in src/pools/abstract-pool.ts:70
Private
Readonly
startTimestamp
startTimestamp: number
@@ -237,7 +239,7 @@
+Defined in src/pools/abstract-pool.ts:87
Protected
workerChoiceStrategyContext
@@ -245,7 +247,7 @@
+Defined in src/pools/abstract-pool.ts:78
Readonly
workerNodes
@@ -254,7 +256,7 @@
+Defined in src/pools/abstract-pool.ts:57
Protected
full
@@ -280,7 +282,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:521
+Defined in src/pools/abstract-pool.ts:252
Protected
Abstract
maxSize
@@ -303,7 +305,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:427
Protected
Abstract
minSize
@@ -314,19 +316,7 @@
Returns number
-
+Defined in src/pools/abstract-pool.ts:422
Protected
Abstract
type
@@ -338,7 +328,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:412
+Defined in src/pools/abstract-pool.ts:391
Protected
Abstract
worker
@@ -361,7 +351,7 @@
Returns "cluster" | "thread"
+Defined in src/pools/abstract-pool.ts:417
Protected
afterWorkerSetup
@@ -408,7 +398,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:869
Protected
beforeTaskExecutionHook
@@ -433,7 +423,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:625
Private
buildTasksQueueOptions
@@ -446,7 +436,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:508
Private
checkAndEmitEvents
@@ -454,7 +444,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1027
Private
checkFilePath
@@ -467,7 +457,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:135
Private
checkNumberOfWorkers
@@ -480,7 +470,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:144
Private
checkPoolOptions
@@ -493,7 +483,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:162
Private
checkValidTasksQueueOptions
@@ -506,7 +496,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:227
Private
checkValidWorkerChoiceStrategy
@@ -519,7 +509,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:189
Private
checkValidWorkerChoiceStrategyOptions
@@ -532,7 +522,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:199
Private
chooseWorkerNode
@@ -545,7 +535,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:811
Protected
createAndSetupDynamicWorker
@@ -557,7 +547,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:947
Protected
createAndSetupWorker
@@ -569,7 +559,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:879
Protected
Abstract
createWorker
@@ -581,7 +571,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:861
Private
dequeueTask
@@ -594,7 +584,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1140
+Defined in src/pools/abstract-pool.ts:580
Protected
Abstract
destroyWorker
@@ -625,7 +615,7 @@ Can be overridden.
Returns void | Promise<void>
+Defined in src/pools/abstract-pool.ts:601
+Defined in src/pools/abstract-pool.ts:486
Private
enqueueTask
@@ -665,7 +655,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1136
+Defined in src/pools/abstract-pool.ts:546
Private
executeTask
@@ -706,7 +696,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:1131
Private
flushTasksQueue
@@ -719,7 +709,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1152
Private
flushTasksQueues
@@ -727,7 +717,33 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1162
+
+Private
getInitialWorkerInfo
+
+
+Private
getInitialWorkerUsage
+
+- getInitialWorkerUsage(worker?): WorkerUsage
+-
+
+
Parameters
+
+-
+
Optional
worker: Worker
+
Private
getWorkerById
@@ -747,7 +763,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:435
Private
getWorkerId
@@ -767,7 +783,26 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1086
+
+Private
getWorkerInfo
+
+- getWorkerInfo(workerNodeKey): WorkerInfo
+-
+
+
+
Parameters
+
+-
+
workerNodeKey: number
+
+
+
+
Private
getWorkerNodeKey
@@ -787,20 +822,7 @@ Can be overridden.
-
-Private
getWorkerUsage
-
-- getWorkerUsage(workerNodeKey?): WorkerUsage
--
-
-
Parameters
-
--
-
Optional
workerNodeKey: number
-
+Defined in src/pools/abstract-pool.ts:446
Private
handleTaskExecutionResponse
@@ -813,7 +835,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1000
Private
handleWorkerStartedMessage
@@ -826,7 +848,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:985
Protected
internalBusy
@@ -838,7 +860,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:537
Protected
Abstract
isMain
@@ -849,7 +871,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:616
Private
pushWorkerNode
@@ -869,7 +891,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1066
+
+Private
redistributeQueuedTasks
+
+- redistributeQueuedTasks(worker): void
+-
+
+
Returns void
Private
registerWorkerMessageListener
@@ -909,7 +944,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:849
Private
removeWorkerNode
@@ -928,7 +963,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1123
Protected
Abstract
sendToWorker
@@ -952,7 +987,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:838
+Defined in src/pools/abstract-pool.ts:498
+Defined in src/pools/abstract-pool.ts:453
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:475
Private
setWorkerNodeTasksUsage
@@ -1041,7 +1076,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1044
Private
setWorkerStatistics
@@ -1054,7 +1089,7 @@ Can be overridden.
worker: Worker
Returns void
+Defined in src/pools/abstract-pool.ts:1168
Protected
setupHook
@@ -1066,7 +1101,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:609
Private
shallCreateDynamicWorker
@@ -1078,7 +1113,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:828
Private
tasksMaxQueueSize
@@ -1091,7 +1126,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1148
Private
tasksQueueSize
@@ -1104,7 +1139,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1144
Private
updateEluWorkerUsage
@@ -1119,7 +1154,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:740
Private
updateRunTimeWorkerUsage
@@ -1134,7 +1169,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:664
Private
updateTaskStatisticsWorkerUsage
@@ -1149,7 +1184,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:651
Private
updateWaitTimeWorkerUsage
@@ -1164,7 +1199,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:702
Protected
workerListener
@@ -1191,7 +1226,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:973
Gets the pool run time.
-