X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=cc82e4d6bccebfee7371b17027b71782b4e7a3d7;hb=842d8918a19fc2720d4436789a2e373bc623452e;hp=adb04610252b659ce602b18ff09a5772222da20f;hpb=e4b9c7f546318de7603566b141fd0e2d0118c794;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index adb04610..cc82e4d6 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -45,7 +45,7 @@
- IPool<Worker, Data, Response>
+Defined in src/pools/abstract-pool.ts:32
@@ -145,7 +145,7 @@
Returns AbstractPool<Worker, Data, Response>
+Defined in src/pools/abstract-pool.ts:74
Readonly
filePath
filePath: string
+Defined in src/pools/abstract-pool.ts:76
Readonly
numberOfWorkers
numberOfWorkers: number
+Defined in src/pools/abstract-pool.ts:75
+Defined in src/pools/abstract-pool.ts:77
Protected
promiseResponseMap
-promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
+
+Defined in src/pools/abstract-pool.ts:51
Protected
workerChoiceStrategyContext
@@ -201,7 +201,7 @@
Default to a round robin algorithm.
+Defined in src/pools/abstract-pool.ts:61
Readonly
workerNodes
@@ -209,7 +209,7 @@
+Defined in src/pools/abstract-pool.ts:38
+Defined in src/pools/abstract-pool.ts:231
Private
numberOfQueuedTasks
@@ -245,7 +245,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:186
Private
numberOfRunningTasks
@@ -255,19 +255,19 @@
Returns number
+Defined in src/pools/abstract-pool.ts:176
Abstract
type
-- get type(): PoolType
+- get type(): PoolType
-
-
Returns PoolType
+Defined in src/pools/abstract-pool.ts:171
Protected
Abstract
afterWorkerSetup
@@ -309,7 +309,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:415
Protected
beforeTaskExecutionHook
@@ -327,7 +327,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:316
Private
checkAndEmitEvents
@@ -335,7 +335,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:473
Private
checkFilePath
@@ -348,7 +348,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:111
Private
checkNumberOfWorkers
@@ -361,7 +361,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:120
Private
checkPoolOptions
@@ -374,7 +374,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:138
Private
checkValidWorkerChoiceStrategy
@@ -387,7 +387,7 @@ Can be overridden.
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
Returns void
+Defined in src/pools/abstract-pool.ts:160
Protected
chooseWorkerNode
@@ -400,7 +400,7 @@ Can be overridden.
Returns [number, WorkerNode<Worker, Data>]
+Defined in src/pools/abstract-pool.ts:360
Protected
createAndSetupWorker
@@ -412,7 +412,7 @@ Can be overridden.
Returns Worker
+Defined in src/pools/abstract-pool.ts:422
Protected
Abstract
createWorker
@@ -422,20 +422,20 @@ Can be overridden.
Returns Worker
+Defined in src/pools/abstract-pool.ts:406
Private
dequeueTask
-- dequeueTask(workerNodeKey: number): undefined | Task<Data>
+- dequeueTask(workerNodeKey: number): undefined | Task<Data>
-
-
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:574
+Defined in src/pools/abstract-pool.ts:279
Protected
Abstract
destroyWorker
@@ -463,11 +463,11 @@ Can be overridden.
Returns void | Promise<void>
+Defined in src/pools/abstract-pool.ts:293
Private
enqueueTask
Returns number
+Defined in src/pools/abstract-pool.ts:570
+Defined in src/pools/abstract-pool.ts:248
Private
executeTask
Returns void
+Defined in src/pools/abstract-pool.ts:565
+Defined in src/pools/abstract-pool.ts:241
Private
flushTasksQueue
@@ -541,7 +541,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:582
Private
flushTasksQueueByWorker
@@ -554,7 +554,7 @@ Can be overridden.
worker: Worker
Returns void
+Defined in src/pools/abstract-pool.ts:590
Private
getWorkerNodeKey
@@ -573,11 +573,11 @@ Can be overridden.
Returns number
+Defined in src/pools/abstract-pool.ts:202
Private
getWorkerTasksUsage
-- getWorkerTasksUsage(worker: Worker): undefined | TasksUsage
+- getWorkerTasksUsage(worker: Worker): undefined | TasksUsage
-
-
Returns undefined | TasksUsage
+Defined in src/pools/abstract-pool.ts:503
Protected
internalBusy
@@ -600,7 +600,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:236
Protected
Abstract
isMain
@@ -610,7 +610,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:308
Private
pushWorkerNode
@@ -629,7 +629,7 @@ Can be overridden.
Returns number
+Defined in src/pools/abstract-pool.ts:517
Protected
Abstract
registerWorkerMessageListener
@@ -666,7 +666,7 @@ Can be overridden.
Returns void
Returns void
+Defined in src/pools/abstract-pool.ts:399
Private
removeWorkerNode
@@ -683,7 +683,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:559
Protected
Abstract
sendToWorker
@@ -704,7 +704,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:388
+Defined in src/pools/abstract-pool.ts:209
Private
setWorkerNode
-- setWorkerNode(workerNodeKey: number, worker: Worker, tasksUsage: TasksUsage, tasksQueue: Task<Data>[]): void
+- setWorkerNode(workerNodeKey: number, worker: Worker, tasksUsage: TasksUsage, tasksQueue: Task<Data>[]): void
-
@@ -742,20 +742,20 @@ Can be overridden.
-
-
tasksUsage: TasksUsage
+
-
-
tasksQueue: Task<Data>[]
+tasksQueue: Task<Data>[]
Returns void
+Defined in src/pools/abstract-pool.ts:541
Private
setWorkerNodeTasksUsage
-- setWorkerNodeTasksUsage(workerNode: WorkerNode<Worker, Data>, tasksUsage: TasksUsage): void
+- setWorkerNodeTasksUsage(workerNode: WorkerNode<Worker, Data>, tasksUsage: TasksUsage): void
-
@@ -767,12 +767,12 @@ Can be overridden.
-
-
tasksUsage: TasksUsage
+
Returns void
+Defined in src/pools/abstract-pool.ts:490
Protected
setupHook
@@ -783,7 +783,7 @@ Can be overridden
Returns void
+Defined in src/pools/abstract-pool.ts:301
Private
tasksQueueSize
@@ -796,7 +796,7 @@ Can be overridden
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:578
Protected
workerListener
@@ -823,7 +823,7 @@ Can be overridden
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:445
Path to the worker-file.