X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=3017080f50280e841fa22694bfd919296b6a82cb;hb=f63918da6f3fc77cc7f98e4d43e3f37955140468;hp=eb849df04c960300dec6bba54fbacb452fe92052;hpb=d6b93f1ae5603949390418b787e0ad51b026f9c5;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index eb849df0..3017080f 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -31,7 +31,7 @@
Response = unknown
-
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
@@ -201,7 +206,7 @@
Default to a round robin algorithm.
+Defined in src/pools/abstract-pool.ts:62
Readonly
workerNodes
@@ -209,7 +214,7 @@
+Defined in src/pools/abstract-pool.ts:39
Protected
Abstract
full
@@ -233,7 +238,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:291
Private
numberOfQueuedTasks
@@ -243,7 +248,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:195
Private
numberOfRunningTasks
@@ -253,7 +258,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:185
+Defined in src/pools/abstract-pool.ts:180
Protected
Abstract
afterWorkerSetup
@@ -307,7 +312,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:479
Protected
beforeTaskExecutionHook
@@ -325,7 +330,20 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:380
+
+Private
buildTasksQueueOptions
+
Private
checkAndEmitEvents
@@ -333,7 +351,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:537
Private
checkFilePath
@@ -346,7 +364,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:112
Private
checkNumberOfWorkers
@@ -359,7 +377,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:121
Private
checkPoolOptions
@@ -372,7 +390,20 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:139
+
+Private
checkValidTasksQueueOptions
+
+- checkValidTasksQueueOptions(tasksQueueOptions: TasksQueueOptions): void
+-
+
+
Returns void
Private
checkValidWorkerChoiceStrategy
@@ -385,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
@@ -398,7 +429,7 @@ Can be overridden.
Returns [number, WorkerNode<Worker, Data>]
+Defined in src/pools/abstract-pool.ts:424
Protected
createAndSetupWorker
@@ -410,7 +441,7 @@ Can be overridden.
Returns Worker
+Defined in src/pools/abstract-pool.ts:486
Protected
Abstract
createWorker
@@ -420,7 +451,7 @@ Can be overridden.
Returns Worker
+Defined in src/pools/abstract-pool.ts:470
Private
dequeueTask
@@ -433,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
@@ -461,7 +492,29 @@ Can be overridden.
Returns void | Promise<void>
+Defined in src/pools/abstract-pool.ts:357
+
+enableTasksQueue
+
+- enableTasksQueue(enable: boolean, tasksQueueOptions?: TasksQueueOptions): void
+-
+
+
+
Parameters
+
+-
+
enable: boolean
+
+-
+
+
+Returns void
Private
enqueueTask
@@ -476,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
@@ -539,7 +592,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:647
Private
flushTasksQueueByWorker
@@ -552,7 +605,7 @@ Can be overridden.
worker: Worker
Returns void
+Defined in src/pools/abstract-pool.ts:655
Private
getWorkerNodeKey
@@ -571,7 +624,7 @@ Can be overridden.
Returns number
+Defined in src/pools/abstract-pool.ts:211
Private
getWorkerTasksUsage
+Defined in src/pools/abstract-pool.ts:568
Protected
internalBusy
@@ -598,7 +653,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:300
Protected
Abstract
isMain
@@ -608,7 +663,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:372
Private
pushWorkerNode
@@ -627,7 +682,7 @@ Can be overridden.
Returns number
+Defined in src/pools/abstract-pool.ts:582
Protected
Abstract
registerWorkerMessageListener
@@ -664,7 +719,7 @@ Can be overridden.
Returns void
Returns void
+Defined in src/pools/abstract-pool.ts:463
Private
removeWorkerNode
@@ -681,7 +736,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:624
Protected
Abstract
sendToWorker
@@ -702,11 +757,29 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:452
+
+setTasksQueueOptions
+
+- setTasksQueueOptions(tasksQueueOptions: TasksQueueOptions): void
+-
+
+
+
Returns void
setWorkerChoiceStrategy
-- setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
+- setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions): void
-
@@ -716,11 +789,33 @@ Can be overridden.
-
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+-
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:218
+
+setWorkerChoiceStrategyOptions
+
Private
setWorkerNode
@@ -749,7 +844,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:606
Private
setWorkerNodeTasksUsage
@@ -770,7 +865,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:554
Protected
setupHook
@@ -781,7 +876,7 @@ Can be overridden
Returns void
+Defined in src/pools/abstract-pool.ts:365
Private
tasksQueueSize
@@ -794,7 +889,7 @@ Can be overridden
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:643
Protected
workerListener
@@ -821,7 +916,7 @@ Can be overridden
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:509
Type of response of execution. This can only be serializable data.
+Type of execution response. This can only be serializable data.
Hierarchy
@@ -45,7 +45,7 @@@@ -78,10 +78,12 @@after Task Execution Hook
after Worker Setup
before Task Execution Hook
+build Tasks Queue Options
check And Emit Events
check File Path
check Number Of Workers
check Pool Options
+check Valid Tasks Queue Options
check Valid Worker Choice Strategy
choose Worker Node
create And Setup Worker
@@ -89,6 +91,7 @@
dequeue Task
destroy
destroy Worker
+enable Tasks Queue
enqueue Task
execute
execute Task
@@ -103,7 +106,9 @@
register Worker Message Listener
remove Worker Node
send To Worker
+set Tasks Queue Options
set Worker Choice Strategy
+set Worker Choice Strategy Options
set Worker Node
set Worker Node Tasks Usage
setup Hook
@@ -137,7 +142,7 @@
filePath: string
-Path to the worker-file.
+Path to the worker file.
opts: PoolOptions<Worker>
@@ -145,7 +150,7 @@