X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=c67d842f1d422de5b07647acb15ad441ecc3dcb8;hb=ccb7d1a70cd9bd4eb050160517e5bc48311d014f;hp=2fbe8e0e38a3611f4d0f020997b1df6f7f68314f;hpb=1bb559f95ee0232e20550e28e4cfd3f6556cd8a8;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 2fbe8e0e..c67d842f 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
@@ -150,7 +152,7 @@
Returns AbstractPool<Worker, Data, Response>
+Defined in src/pools/abstract-pool.ts:77
Properties
@@ -161,32 +163,34 @@
'full'
: Emitted when the pool is dynamic and full.
'busy'
: Emitted when the pool is busy.
+'error'
: Emitted when an uncaught error occurs.
+'taskError'
: Emitted when an error occurs while executing a task.
+Defined in src/pools/abstract-pool.ts:44
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 +202,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 +210,7 @@
Default to a round robin algorithm.
+Defined in src/pools/abstract-pool.ts:64
Readonly
workerNodes
@@ -214,7 +218,7 @@
+Defined in src/pools/abstract-pool.ts:41
Protected
Abstract
full
@@ -238,7 +242,7 @@
Returns boolean
+Defined in src/pools/abstract-pool.ts:329
Private
numberOfQueuedTasks
@@ -248,7 +252,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:230
Private
numberOfRunningTasks
@@ -258,7 +262,7 @@
Returns number
+Defined in src/pools/abstract-pool.ts:220
+Defined in src/pools/abstract-pool.ts:215
+Defined in src/pools/abstract-pool.ts:212
Protected
Abstract
afterWorkerSetup
@@ -323,7 +327,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:554
Protected
beforeTaskExecutionHook
@@ -341,7 +345,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:419
Private
buildTasksQueueOptions
@@ -354,7 +358,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:316
Private
checkAndEmitEvents
@@ -362,7 +366,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:628
Private
checkFilePath
@@ -375,7 +379,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:114
Private
checkNumberOfWorkers
@@ -388,7 +392,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:123
Private
checkPoolOptions
@@ -401,7 +405,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:141
Private
checkValidTasksQueueOptions
@@ -414,7 +418,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:196
Private
checkValidWorkerChoiceStrategy
@@ -424,10 +428,10 @@ Can be overridden.
Parameters
-
-
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Returns void
+Defined in src/pools/abstract-pool.ts:168
Private
checkValidWorkerChoiceStrategyOptions
@@ -440,19 +444,19 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:178
Protected
chooseWorkerNode
+Defined in src/pools/abstract-pool.ts:498
Protected
createAndSetupWorker
@@ -463,7 +467,7 @@ Can be overridden.
Returns Worker
New, completely set up worker.
+Defined in src/pools/abstract-pool.ts:561
Protected
Abstract
createWorker
@@ -473,7 +477,7 @@ Can be overridden.
Returns Worker
+Defined in src/pools/abstract-pool.ts:545
Private
dequeueTask
@@ -486,7 +490,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:727
+Defined in src/pools/abstract-pool.ts:382
Protected
Abstract
destroyWorker
@@ -514,7 +518,7 @@ Can be overridden.
Returns void | Promise<void>
+Defined in src/pools/abstract-pool.ts:396
+Defined in src/pools/abstract-pool.ts:294
Private
enqueueTask
@@ -551,7 +555,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:723
+Defined in src/pools/abstract-pool.ts:347
Private
executeTask
@@ -589,7 +593,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:718
Private
flushTasksQueue
@@ -602,7 +606,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:735
Private
flushTasksQueues
@@ -610,7 +614,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:746
Private
getWorkerNodeKey
@@ -628,7 +632,7 @@ Can be overridden.
Returns number
The worker node key if the worker is found in the pool worker nodes, -1
otherwise.
+Defined in src/pools/abstract-pool.ts:246
Protected
internalBusy
@@ -636,7 +640,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:338
Protected
Abstract
isMain
@@ -646,7 +650,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:411
Private
pushWorkerNode
@@ -664,7 +668,7 @@ Can be overridden.
Returns number
The worker nodes length.
+Defined in src/pools/abstract-pool.ts:664
Protected
Abstract
registerWorkerMessageListener
@@ -701,7 +705,7 @@ Can be overridden.
Returns void
Returns void
+Defined in src/pools/abstract-pool.ts:538
Private
removeWorkerNode
@@ -718,7 +722,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:710
Protected
Abstract
sendToWorker
@@ -739,7 +743,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:527
+Defined in src/pools/abstract-pool.ts:306
setWorkerChoiceStrategy
@@ -769,7 +773,7 @@ Can be overridden.
Parameters
-
-
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
-
@@ -779,7 +783,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:253
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:283
Private
setWorkerNode
@@ -826,7 +830,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:692
Private
setWorkerNodeTasksUsage
@@ -847,7 +851,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:651
Protected
setupHook
@@ -858,7 +862,7 @@ Can be overridden
Returns void
+Defined in src/pools/abstract-pool.ts:404
Private
tasksQueueSize
@@ -871,7 +875,37 @@ Can be overridden
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:731
+
+Private
updateRunTimeTasksUsage
+
+- updateRunTimeTasksUsage(workerTasksUsage, message): void
+-
+
+
Parameters
+
+-
+
+-
+
message: MessageValue<Response, Worker | MessagePort>
+Returns void
+
+Private
updateWaitTimeTasksUsage
+
+- updateWaitTimeTasksUsage(workerTasksUsage, message): void
+-
+
+
Parameters
+
+-
+
+-
+
message: MessageValue<Response, Worker | MessagePort>
+Returns void
+Defined in src/pools/abstract-pool.ts:594
Path to the worker file.