X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=c2a8b6536daffaff46d340383a50c19f7e64e4cf;hb=dea288f11483ea6c15807b20e4c621483c7fa5af;hp=2377e5ef16fdc1a416ee8a3b6d1c857875680190;hpb=396360a789e4806699533ddf899c79dc2b7ae868;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 2377e5ef..c2a8b653 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:35
+Defined in src/pools/abstract-pool.ts:77
Readonly
filePath
filePath: string
+Defined in src/pools/abstract-pool.ts:79
Readonly
numberOfWorkers
numberOfWorkers: number
+Defined in src/pools/abstract-pool.ts:78
+Defined in src/pools/abstract-pool.ts:80
Protected
promiseResponseMap
@@ -198,7 +198,7 @@
When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.
+Defined in src/pools/abstract-pool.ts:54
Protected
workerChoiceStrategyContext
@@ -206,7 +206,7 @@
Default to a round robin algorithm.
+Defined in src/pools/abstract-pool.ts:64
Readonly
workerNodes
@@ -214,7 +214,7 @@
+Defined in src/pools/abstract-pool.ts:41
Protected
Abstract
full
@@ -238,7 +238,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:313
Private
numberOfQueuedTasks
@@ -248,7 +248,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:218
Private
numberOfRunningTasks
@@ -258,7 +258,18 @@
Returns number
+Defined in src/pools/abstract-pool.ts:208
+
+Abstract
size
+
+- get size(): number
+-
+
+
Returns number
+Defined in src/pools/abstract-pool.ts:200
Protected
Abstract
afterWorkerSetup
@@ -312,7 +323,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:502
Protected
beforeTaskExecutionHook
@@ -330,7 +341,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:401
Private
buildTasksQueueOptions
@@ -343,7 +354,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:300
Private
checkAndEmitEvents
@@ -351,7 +362,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:560
Private
checkFilePath
@@ -364,7 +375,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:114
Private
checkNumberOfWorkers
@@ -377,7 +388,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:123
Private
checkPoolOptions
@@ -390,7 +401,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:141
Private
checkValidTasksQueueOptions
@@ -403,7 +414,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:184
Private
checkValidWorkerChoiceStrategy
@@ -416,7 +427,20 @@ Can be overridden.
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
Returns void
+Defined in src/pools/abstract-pool.ts:164
+
+Private
checkValidWorkerChoiceStrategyOptions
+
+- checkValidWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void
+-
+
+
Returns void
Protected
chooseWorkerNode
@@ -428,7 +452,7 @@ Can be overridden.
Returns [number, WorkerNode<Worker, Data>]
[worker node key, worker node].
+Defined in src/pools/abstract-pool.ts:446
Protected
createAndSetupWorker
@@ -439,7 +463,7 @@ Can be overridden.
Returns Worker
New, completely set up worker.
+Defined in src/pools/abstract-pool.ts:509
Protected
Abstract
createWorker
@@ -449,7 +473,7 @@ Can be overridden.
Returns Worker
+Defined in src/pools/abstract-pool.ts:493
Private
dequeueTask
@@ -462,7 +486,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:647
+Defined in src/pools/abstract-pool.ts:364
Protected
Abstract
destroyWorker
@@ -490,7 +514,7 @@ Can be overridden.
Returns void | Promise<void>
+Defined in src/pools/abstract-pool.ts:378
+Defined in src/pools/abstract-pool.ts:278
Private
enqueueTask
@@ -527,11 +551,11 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:643
execute
-- execute(data?): Promise<Response>
+- execute(data?, name?): Promise<Response>
-
@@ -541,12 +565,16 @@ Can be overridden.
-
Optional
data: Data
+-
+
Optional
name: string
+
Returns Promise<Response>
Promise that will be fulfilled when the task is completed.
+Defined in src/pools/abstract-pool.ts:331
Private
executeTask
@@ -561,7 +589,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:638
Private
flushTasksQueue
@@ -574,20 +602,7 @@ Can be overridden.
workerNodeKey: number
Returns void
-
-Private
flushTasksQueueByWorker
-
-- flushTasksQueueByWorker(worker): void
--
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:655
Private
flushTasksQueues
@@ -595,7 +610,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:666
Private
getWorkerNodeKey
@@ -613,27 +628,7 @@ Can be overridden.
Returns number
The worker node key if the worker is found in the pool worker nodes, -1
otherwise.
-
-Private
getWorkerTasksUsage
-
-- getWorkerTasksUsage(worker): TasksUsage
--
-
-
-
The worker tasks usage.
-
+Defined in src/pools/abstract-pool.ts:234
Protected
internalBusy
@@ -641,7 +636,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:322
Protected
Abstract
isMain
@@ -651,7 +646,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:393
Private
pushWorkerNode
@@ -669,7 +664,7 @@ Can be overridden.
Returns number
The worker nodes length.
+Defined in src/pools/abstract-pool.ts:590
Protected
Abstract
registerWorkerMessageListener
@@ -702,11 +697,11 @@ Can be overridden.
Parameters
+message: MessageValue<Message, Worker | MessagePort>
Returns void
Returns void
+Defined in src/pools/abstract-pool.ts:486
Private
removeWorkerNode
@@ -723,7 +718,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:632
Protected
Abstract
sendToWorker
@@ -739,12 +734,12 @@ Can be overridden.
-
-
+
message: MessageValue<Data, Worker | MessagePort>
Returns void
+Defined in src/pools/abstract-pool.ts:475
+Defined in src/pools/abstract-pool.ts:290
+Defined in src/pools/abstract-pool.ts:241
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:267
Private
setWorkerNode
@@ -826,12 +821,12 @@ Can be overridden.
-
-
tasksQueue: Task<Data>[]
+tasksQueue: Queue<Task<Data>>
Returns void
+Defined in src/pools/abstract-pool.ts:614
Private
setWorkerNodeTasksUsage
@@ -852,7 +847,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:577
Protected
setupHook
@@ -863,7 +858,7 @@ Can be overridden
Returns void
+Defined in src/pools/abstract-pool.ts:386
Private
tasksQueueSize
@@ -876,7 +871,7 @@ Can be overridden
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:651
Protected
workerListener
@@ -897,11 +892,11 @@ Can be overridden
Parameters
+message: MessageValue<Response, Worker | MessagePort>
Returns void
The listener function to execute when a message is received from a worker.
+Defined in src/pools/abstract-pool.ts:532
Path to the worker file.