X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=665bed64345afad593c4644dd8264140f2a95d47;hb=761b0c73be0bf581f50a78123913f933bd405f52;hp=d5c7d4f199d2e1a6dd75c152449a471b3658a6ac;hpb=6709f3086622c12bae8060915be7a7f6be9d9763;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index d5c7d4f1..665bed64 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:33
+Defined in src/pools/abstract-pool.ts:75
Readonly
filePath
filePath: string
-
+Defined in src/pools/abstract-pool.ts:52
Protected
workerChoiceStrategyContext
@@ -206,7 +207,7 @@
Default to a round robin algorithm.
+Defined in src/pools/abstract-pool.ts:62
Readonly
workerNodes
@@ -214,7 +215,7 @@
+Defined in src/pools/abstract-pool.ts:39
Protected
Abstract
full
@@ -238,7 +239,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:289
Private
numberOfQueuedTasks
@@ -248,7 +249,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:195
Private
numberOfRunningTasks
@@ -258,7 +259,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:185
+Defined in src/pools/abstract-pool.ts:180
Protected
Abstract
afterWorkerSetup
@@ -312,7 +313,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:477
Protected
beforeTaskExecutionHook
@@ -330,7 +331,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:378
Private
buildTasksQueueOptions
@@ -343,7 +344,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:276
Private
checkAndEmitEvents
@@ -351,7 +352,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:535
Private
checkFilePath
@@ -364,7 +365,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:112
Private
checkNumberOfWorkers
@@ -377,7 +378,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:121
Private
checkPoolOptions
@@ -390,7 +391,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:139
Private
checkValidTasksQueueOptions
@@ -403,7 +404,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:167
Private
checkValidWorkerChoiceStrategy
@@ -416,7 +417,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:157
Protected
chooseWorkerNode
@@ -429,7 +430,7 @@ Can be overridden.
Returns [number, WorkerNode<Worker, Data>]
+Defined in src/pools/abstract-pool.ts:422
Protected
createAndSetupWorker
@@ -441,7 +442,7 @@ Can be overridden.
Returns Worker
+Defined in src/pools/abstract-pool.ts:484
Protected
Abstract
createWorker
@@ -451,7 +452,7 @@ Can be overridden.
Returns Worker
+Defined in src/pools/abstract-pool.ts:468
Private
dequeueTask
@@ -464,7 +465,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:637
+Defined in src/pools/abstract-pool.ts:341
Protected
Abstract
destroyWorker
@@ -492,11 +493,11 @@ Can be overridden.
Returns void | Promise<void>
+Defined in src/pools/abstract-pool.ts:355
enableTasksQueue
-- enableTasksQueue(enable: boolean, opts?: TasksQueueOptions): void
+- enableTasksQueue(enable: boolean, tasksQueueOptions?: TasksQueueOptions): void
-
@@ -508,11 +509,13 @@ Can be overridden.
-
-
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:254
Private
enqueueTask
@@ -527,27 +530,27 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:633
execute
-- execute(data: Data): Promise<Response>
+- execute(data?: Data): Promise<Response>
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:645
Private
flushTasksQueueByWorker
@@ -603,7 +606,15 @@ Can be overridden.
worker: Worker
Returns void
+Defined in src/pools/abstract-pool.ts:653
+
+Private
flushTasksQueues
+
+- flushTasksQueues(): void
+-
+
Returns void
Private
getWorkerNodeKey
@@ -622,7 +633,7 @@ Can be overridden.
Returns number
+Defined in src/pools/abstract-pool.ts:211
Private
getWorkerTasksUsage
@@ -643,7 +654,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:566
Protected
internalBusy
@@ -651,7 +662,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:298
Protected
Abstract
isMain
@@ -661,7 +672,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:370
Private
pushWorkerNode
@@ -680,7 +691,7 @@ Can be overridden.
Returns number
+Defined in src/pools/abstract-pool.ts:580
Protected
Abstract
registerWorkerMessageListener
@@ -717,7 +728,7 @@ Can be overridden.
Returns void
Returns void
+Defined in src/pools/abstract-pool.ts:461
Private
removeWorkerNode
@@ -734,7 +745,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:622
Protected
Abstract
sendToWorker
@@ -755,11 +766,11 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:450
setTasksQueueOptions
-- setTasksQueueOptions(opts: TasksQueueOptions): void
+- setTasksQueueOptions(tasksQueueOptions: TasksQueueOptions): void
-
@@ -767,13 +778,13 @@ Can be overridden.
Parameters
Returns void
+Defined in src/pools/abstract-pool.ts:266
+Defined in src/pools/abstract-pool.ts:218
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:244
Private
setWorkerNode
@@ -842,7 +853,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:604
Private
setWorkerNodeTasksUsage
@@ -863,7 +874,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:552
Protected
setupHook
@@ -874,7 +885,7 @@ Can be overridden
Returns void
+Defined in src/pools/abstract-pool.ts:363
Private
tasksQueueSize
@@ -887,7 +898,7 @@ Can be overridden
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:641
Protected
workerListener
@@ -914,7 +925,7 @@ Can be overridden
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:507
Path to the worker-file.
+Path to the worker file.
opts: PoolOptions<Worker>
@@ -150,7 +151,7 @@