X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=4a702c21b1eeab59420a01ffa9169bf18e4916d7;hb=80520ca4c78c2a023bf78e96769317f7e1eeb6e5;hp=4782daeebb94564871a2e6088604d5a99b48fea0;hpb=202bcb6b999895ba5c5ef42eccd6a95836d21602;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 4782daee..4a702c21 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier
+AbstractPool | poolifier - v2.6.15
@@ -49,7 +49,7 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:54
+
Defined in src/pools/abstract-pool.ts:102
Protected
promiseResponseMap
@@ -229,7 +232,7 @@
+Defined in src/pools/abstract-pool.ts:73
Private
Readonly
startTimestamp
startTimestamp: number
@@ -237,7 +240,7 @@
+Defined in src/pools/abstract-pool.ts:90
Protected
workerChoiceStrategyContext
@@ -245,16 +248,16 @@
+Defined in src/pools/abstract-pool.ts:81
+Defined in src/pools/abstract-pool.ts:60
Protected
full
@@ -280,7 +283,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:590
+Defined in src/pools/abstract-pool.ts:283
Protected
Abstract
maxSize
@@ -303,7 +306,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:482
Protected
Abstract
minSize
@@ -314,19 +317,23 @@
Returns number
-
+
+Defined in src/pools/abstract-pool.ts:429
+
+Private
starting
+
+- get starting(): boolean
+-
+
Returns boolean
Protected
Abstract
type
@@ -338,7 +345,7 @@
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:467
+Defined in src/pools/abstract-pool.ts:446
Protected
Abstract
worker
@@ -361,9 +368,29 @@
Returns "cluster" | "thread"
+Defined in src/pools/abstract-pool.ts:472
Methods
+
+Private
addWorkerNode
+
+- addWorkerNode(worker): number
+-
+
+
+
Returns number
The worker nodes length.
+
+
Protected
afterTaskExecutionHook
@@ -388,7 +415,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:716
Protected
afterWorkerSetup
@@ -408,7 +435,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1026
Protected
beforeTaskExecutionHook
@@ -433,7 +460,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:695
Private
buildTasksQueueOptions
@@ -446,7 +473,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:577
Private
checkAndEmitEvents
@@ -454,7 +481,22 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1126
+
+Protected
checkDynamicPoolSize
+
+- checkDynamicPoolSize(min, max): void
+-
+
+
Parameters
+
+-
+
min: number
+-
+
max: number
+Returns void
Private
checkFilePath
@@ -467,7 +509,28 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:144
+
+Private
checkMessageWorkerId
+
+- checkMessageWorkerId(message): void
+-
+
+
+
Returns void
+
Private
checkNumberOfWorkers
@@ -480,7 +543,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:157
Private
checkPoolOptions
@@ -493,7 +556,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:193
Private
checkValidTasksQueueOptions
@@ -506,7 +569,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:258
Private
checkValidWorkerChoiceStrategy
@@ -519,7 +582,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:220
Private
checkValidWorkerChoiceStrategyOptions
@@ -532,7 +595,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:230
Private
chooseWorkerNode
@@ -545,7 +608,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:893
Protected
createAndSetupDynamicWorker
@@ -557,7 +620,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:978
Protected
createAndSetupWorker
@@ -569,7 +632,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:937
Protected
Abstract
createWorker
@@ -581,7 +644,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:930
Private
dequeueTask
@@ -594,7 +657,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1189
+Defined in src/pools/abstract-pool.ts:650
Protected
Abstract
destroyWorker
@@ -625,7 +688,7 @@ Can be overridden.
Returns void | Promise<void>
+Defined in src/pools/abstract-pool.ts:671
+Defined in src/pools/abstract-pool.ts:555
Private
enqueueTask
@@ -665,7 +728,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1185
+Defined in src/pools/abstract-pool.ts:615
Private
executeTask
- executeTask(workerNodeKey, task): void
-
+
Parameters
-
workerNodeKey: number
-
-
task: Task<Data>
-Returns void
+Returns void
+
+Defined in src/pools/abstract-pool.ts:1180
Private
flushTasksQueue
@@ -719,7 +788,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1197
Private
flushTasksQueues
@@ -727,7 +796,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1207
Private
getWorkerById
@@ -747,27 +816,26 @@ Can be overridden.
-
+
+Private
getWorkerInfo
-- getWorkerId(worker): undefined | number
+- getWorkerInfo(workerNodeKey): WorkerInfo
-
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1042
Private
registerWorkerMessageListener
@@ -909,7 +957,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1013
Private
removeWorkerNode
@@ -928,7 +976,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1166
Protected
Abstract
sendToWorker
@@ -952,7 +1000,20 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:920
+
+Private
sendWorkerStartupMessage
+
+- sendWorkerStartupMessage(worker): void
+-
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:567
+Defined in src/pools/abstract-pool.ts:525
setWorkerChoiceStrategyOptions
-
-Private
setWorkerNodeTasksUsage
-
-- setWorkerNodeTasksUsage(workerNode, workerUsage): void
--
-
-
-
Parameters
-
--
-
workerNode: WorkerNode<Worker, Data>
-
-
--
-
-
-
-Returns void
-
+Defined in src/pools/abstract-pool.ts:544
Private
setWorkerStatistics
@@ -1054,7 +1091,7 @@ Can be overridden.
worker: Worker
Returns void
+Defined in src/pools/abstract-pool.ts:1213
Protected
setupHook
@@ -1066,7 +1103,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:679
Private
shallCreateDynamicWorker
@@ -1078,20 +1115,7 @@ Can be overridden.
-
-Private
tasksMaxQueueSize
-
-- tasksMaxQueueSize(workerNodeKey): number
--
-
-
Returns number
+Defined in src/pools/abstract-pool.ts:910
Private
tasksQueueSize
@@ -1104,7 +1128,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1193
Private
updateEluWorkerUsage
@@ -1119,7 +1143,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:822
Private
updateRunTimeWorkerUsage
@@ -1134,7 +1158,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:746
Private
updateTaskStatisticsWorkerUsage
@@ -1149,7 +1173,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:733
Private
updateWaitTimeWorkerUsage
@@ -1164,7 +1188,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:784
Protected
workerListener
@@ -1191,7 +1215,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1077
Emitter on which events can be listened to.
Events that can currently be listened to:
-
-
+
+
+
@@ -192,7 +195,7 @@ +'full'
: Emitted when the pool is dynamic and full.'busy'
: Emitted when the pool is busy.'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'ready'
: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.Protected
Readonly
file