X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=d4de5e246b01e3fa4aff0b6e52f51ac58066d9e5;hb=b7076c9f9bff47cc233fb67df43ae160680c6d6e;hp=d5c7d4f199d2e1a6dd75c152449a471b3658a6ac;hpb=6709f3086622c12bae8060915be7a7f6be9d9763;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index d5c7d4f1..d4de5e24 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
@@ -142,7 +142,7 @@
filePath: string
-
Returns AbstractPool<Worker, Data, Response>
+Defined in src/pools/abstract-pool.ts:75
Readonly
filePath
filePath: string
-
+Defined in src/pools/abstract-pool.ts:52
Protected
workerChoiceStrategyContext
@@ -206,7 +206,7 @@
Default to a round robin algorithm.
+Defined in src/pools/abstract-pool.ts:62
Readonly
workerNodes
@@ -214,7 +214,7 @@
+Defined in src/pools/abstract-pool.ts:39
Protected
Abstract
full
@@ -238,7 +238,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:291
Private
numberOfQueuedTasks
@@ -248,7 +248,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:195
Private
numberOfRunningTasks
@@ -258,7 +258,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:185
+Defined in src/pools/abstract-pool.ts:180
Protected
Abstract
afterWorkerSetup
@@ -312,7 +312,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:479
Protected
beforeTaskExecutionHook
@@ -330,7 +330,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:380
Private
buildTasksQueueOptions
@@ -343,7 +343,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:278
Private
checkAndEmitEvents
@@ -351,7 +351,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:537
Private
checkFilePath
@@ -364,7 +364,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:112
Private
checkNumberOfWorkers
@@ -377,7 +377,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:121
Private
checkPoolOptions
@@ -390,7 +390,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:139
Private
checkValidTasksQueueOptions
@@ -403,7 +403,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:167
Private
checkValidWorkerChoiceStrategy
@@ -416,7 +416,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 +429,7 @@ Can be overridden.
Returns [number, WorkerNode<Worker, Data>]
+Defined in src/pools/abstract-pool.ts:424
Protected
createAndSetupWorker
@@ -441,7 +441,7 @@ Can be overridden.
Returns Worker
+Defined in src/pools/abstract-pool.ts:486
Protected
Abstract
createWorker
@@ -451,7 +451,7 @@ Can be overridden.
Returns Worker
+Defined in src/pools/abstract-pool.ts:470
Private
dequeueTask
@@ -464,7 +464,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:639
+Defined in src/pools/abstract-pool.ts:343
Protected
Abstract
destroyWorker
@@ -492,11 +492,11 @@ Can be overridden.
Returns void | Promise<void>
+Defined in src/pools/abstract-pool.ts:357
enableTasksQueue
-- enableTasksQueue(enable: boolean, opts?: TasksQueueOptions): void
+- enableTasksQueue(enable: boolean, tasksQueueOptions?: TasksQueueOptions): void
-
@@ -508,11 +508,13 @@ Can be overridden.
-
-
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:254
Private
enqueueTask
@@ -527,13 +529,13 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:635
execute
- execute(data: Data): Promise<Response>
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:630
+Defined in src/pools/abstract-pool.ts:305
Private
flushTasksQueue
@@ -590,7 +592,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:647
Private
flushTasksQueueByWorker
@@ -603,7 +605,7 @@ Can be overridden.
worker: Worker
Returns void
+Defined in src/pools/abstract-pool.ts:655
Private
getWorkerNodeKey
@@ -622,7 +624,7 @@ Can be overridden.
Returns number
+Defined in src/pools/abstract-pool.ts:211
Private
getWorkerTasksUsage
@@ -643,7 +645,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:568
Protected
internalBusy
@@ -651,7 +653,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:300
Protected
Abstract
isMain
@@ -661,7 +663,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:372
Private
pushWorkerNode
@@ -680,7 +682,7 @@ Can be overridden.
Returns number
+Defined in src/pools/abstract-pool.ts:582
Protected
Abstract
registerWorkerMessageListener
@@ -717,7 +719,7 @@ Can be overridden.
Returns void
Returns void
+Defined in src/pools/abstract-pool.ts:463
Private
removeWorkerNode
@@ -734,7 +736,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:624
Protected
Abstract
sendToWorker
@@ -755,11 +757,11 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:452
setTasksQueueOptions
-- setTasksQueueOptions(opts: TasksQueueOptions): void
+- setTasksQueueOptions(tasksQueueOptions: TasksQueueOptions): void
-
@@ -767,13 +769,13 @@ Can be overridden.
Parameters
Returns void
+Defined in src/pools/abstract-pool.ts:268
+Defined in src/pools/abstract-pool.ts:218
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:244
Private
setWorkerNode
@@ -842,7 +844,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:606
Private
setWorkerNodeTasksUsage
@@ -863,7 +865,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:554
Protected
setupHook
@@ -874,7 +876,7 @@ Can be overridden
Returns void
+Defined in src/pools/abstract-pool.ts:365
Private
tasksQueueSize
@@ -887,7 +889,7 @@ Can be overridden
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:643
Protected
workerListener
@@ -914,7 +916,7 @@ Can be overridden
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:509
Path to the worker-file.
+Path to the worker file.
opts: PoolOptions<Worker>
@@ -150,7 +150,7 @@