X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=e382e9e16e85fa1b4736e8df9cfd0842e9c02057;hb=3eed67feea0f527e3ee31a6ebb1063883eec3855;hp=2fe2f7cd195f2bbd6499945eb63d4dad225ffc0c;hpb=16f3605c35d8a2ef293a4382c6e846dc27915b4a;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 2fe2f7cd..e382e9e1 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,13 +1,13 @@
-
AbstractPool | poolifier - v2.6.30
@@ -49,32 +49,33 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:59
- Index
+ Index
Constructors
-constructor
+
Properties
-emitter?
+
Accessors
-busy
+
Constructors
-constructor
+constructor
- new AbstractPool<Worker, Data, Response>(numberOfWorkers, filePath, opts): AbstractPool<Worker, Data, Response>
-
@@ -185,7 +195,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:114
Properties
@@ -195,18 +205,18 @@
Events that can currently be listened to:
'ready'
: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
-'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.
+'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.
'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
-- '
destroy
': Emitted when the pool is destroyed.
+'destroy'
: Emitted when the pool is destroyed.
'error'
: Emitted when an uncaught error occurs.
'taskError'
: Emitted when an error occurs while executing a task.
-'backPressure'
: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= pool maximum size^2).
+'backPressure'
: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
+
Defined in src/pools/abstract-pool.ts:68
Protected
Readonly
filePath
filePath: string
@@ -214,7 +224,7 @@
+
Defined in src/pools/abstract-pool.ts:116
Protected
Optional
Readonly
max
max?: number
@@ -222,7 +232,7 @@
+
Defined in src/pools/abstract-pool.ts:92
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -230,7 +240,7 @@
+Defined in src/pools/abstract-pool.ts:115
Protected
Readonly
opts
@@ -238,11 +248,11 @@
+
Defined in src/pools/abstract-pool.ts:117
Protected
promiseResponseMap
-
+
Defined in src/pools/abstract-pool.ts:105
+
+Private
started
+started: boolean
+
+
-Private
Readonly
starting
+Private
starting
starting: boolean
+
Defined in src/pools/abstract-pool.ts:101
Protected
workerChoiceStrategyContext
@@ -275,7 +293,7 @@
+
Defined in src/pools/abstract-pool.ts:83
Readonly
Internal
workerNodes
@@ -284,7 +302,7 @@
+
Defined in src/pools/abstract-pool.ts:65
Protected
full
@@ -310,7 +328,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:722
+
Defined in src/pools/abstract-pool.ts:342
Protected
maxSize
@@ -333,7 +351,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:555
Protected
minSize
@@ -344,7 +362,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:548
Private
ready
@@ -355,7 +373,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:500
Protected
Abstract
type
@@ -367,7 +385,7 @@
Returns "fixed" | "dynamic"
+
Defined in src/pools/abstract-pool.ts:538
+
Defined in src/pools/abstract-pool.ts:517
Protected
Abstract
worker
@@ -390,7 +408,7 @@
Returns "thread" | "cluster"
+
Defined in src/pools/abstract-pool.ts:543
+Defined in src/pools/abstract-pool.ts:1469
Protected
afterTaskExecutionHook
@@ -439,7 +457,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:935
Protected
afterWorkerNodeSetup
@@ -459,7 +477,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1209
Protected
beforeTaskExecutionHook
@@ -484,7 +502,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:905
Private
buildTasksQueueOptions
@@ -497,7 +515,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:671
Private
checkAndEmitDynamicWorkerCreationEvents
@@ -505,7 +523,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1444
Private
checkAndEmitTaskExecutionEvents
@@ -513,7 +531,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1432
Private
checkAndEmitTaskQueuingEvents
@@ -521,7 +539,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1438
Protected
checkDynamicPoolSize
@@ -536,7 +554,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:187
Private
checkFilePath
@@ -549,7 +567,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:156
Private
checkMessageWorkerId
+Defined in src/pools/abstract-pool.ts:565
Private
checkNumberOfWorkers
@@ -583,7 +601,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:169
Private
checkPoolOptions
@@ -596,7 +614,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:213
Private
checkValidTasksQueueOptions
@@ -609,7 +627,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:304
Private
checkValidWorkerChoiceStrategy
@@ -622,7 +640,7 @@ Can be overridden.
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
Returns void
+Defined in src/pools/abstract-pool.ts:244
Private
checkValidWorkerChoiceStrategyOptions
@@ -635,7 +653,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:257
Private
chooseWorkerNode
@@ -648,7 +666,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1062
Protected
createAndSetupDynamicWorkerNode
@@ -660,7 +678,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1152
Protected
createAndSetupWorkerNode
@@ -672,7 +690,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1108
Protected
Abstract
createWorker
@@ -684,7 +702,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1101
Private
dequeueTask
@@ -697,7 +715,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1534
+Defined in src/pools/abstract-pool.ts:850
Protected
Abstract
destroyWorkerNode
@@ -728,32 +746,32 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:881
enableTasksQueue
- enableTasksQueue(enable, tasksQueueOptions?): void
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:1404
Private
handleWorkerReadyResponse
@@ -930,7 +948,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1390
Private
hasBackPressure
@@ -938,7 +956,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:1507
hasWorkerNodeBackPressure
+Defined in src/pools/abstract-pool.ts:1500
Protected
internalBusy
@@ -971,7 +989,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:738
Protected
Abstract
isMain
@@ -982,7 +1000,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:896
+Defined in src/pools/abstract-pool.ts:758
Private
redistributeQueuedTasks
@@ -1008,7 +1026,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1253
Protected
Abstract
registerWorkerMessageListener
@@ -1048,7 +1066,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1196
Private
removeWorkerNode
@@ -1067,7 +1085,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1491
Protected
sendKillMessageToWorker
@@ -1082,7 +1100,7 @@ Can be overridden.
workerId: number
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:860
Protected
Abstract
sendStartupMessageToWorker
@@ -1101,7 +1119,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1233
Private
sendStatisticsMessageToWorker
@@ -1120,7 +1138,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1240
Protected
Abstract
sendToWorker
@@ -1149,27 +1167,56 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1090
+
+Private
setTaskStealing
+
+- setTaskStealing(): void
+-
+
Returns void
setTasksQueueOptions
- setTasksQueueOptions(tasksQueueOptions): void
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:1022
Private
updateRunTimeWorkerUsage
@@ -1309,7 +1415,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:995
Private
updateTaskStatisticsWorkerUsage
@@ -1324,7 +1430,22 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:977
+
+Private
updateTaskStolenStatisticsWorkerUsage
+
+- updateTaskStolenStatisticsWorkerUsage(workerNodeKey, taskName): void
+-
+
+
Parameters
+
+-
+
workerNodeKey: number
+-
+
taskName: string
+Returns void
Private
updateWaitTimeWorkerUsage
@@ -1339,7 +1460,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:1009
Protected
workerListener
@@ -1366,20 +1487,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1372
+
-
\ No newline at end of file
+Generated using TypeDoc
+
\ No newline at end of file
The task execution response promise map.
+The task execution response promise map:
key
: The message id of each submitted task.value
: An object that contains the worker, the execution response promise resolve and reject callbacks.Private
Readonly
start