X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=86fada26adb28db38824ca5ecf87c2b5d236b18c;hb=ef29303558d4caf5ff412db9579ea28346b77f3f;hp=2fe2f7cd195f2bbd6499945eb63d4dad225ffc0c;hpb=edc0cdb11d19cc5993ca98004a7dbbf49439acd8;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 2fe2f7cd..86fada26 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 +191,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:114
Properties
@@ -195,18 +201,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 +220,7 @@
+
Defined in src/pools/abstract-pool.ts:116
Protected
Optional
Readonly
max
max?: number
@@ -222,7 +228,7 @@
+
Defined in src/pools/abstract-pool.ts:92
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -230,7 +236,7 @@
+Defined in src/pools/abstract-pool.ts:115
Protected
Readonly
opts
@@ -238,11 +244,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 +289,7 @@
+
Defined in src/pools/abstract-pool.ts:83
Readonly
Internal
workerNodes
@@ -284,7 +298,7 @@
+
Defined in src/pools/abstract-pool.ts:65
Protected
full
@@ -310,7 +324,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:676
+
Defined in src/pools/abstract-pool.ts:334
Protected
maxSize
@@ -333,7 +347,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:547
Protected
minSize
@@ -344,7 +358,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:540
Private
ready
@@ -355,7 +369,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:492
Protected
Abstract
type
@@ -367,7 +381,7 @@
Returns "fixed" | "dynamic"
+
Defined in src/pools/abstract-pool.ts:530
+
Defined in src/pools/abstract-pool.ts:509
Protected
Abstract
worker
@@ -390,7 +404,7 @@
Returns "thread" | "cluster"
+
Defined in src/pools/abstract-pool.ts:535
+Defined in src/pools/abstract-pool.ts:1423
Protected
afterTaskExecutionHook
@@ -439,7 +453,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:889
Protected
afterWorkerNodeSetup
@@ -459,7 +473,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1163
Protected
beforeTaskExecutionHook
@@ -484,7 +498,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:859
Private
buildTasksQueueOptions
@@ -497,7 +511,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:657
Private
checkAndEmitDynamicWorkerCreationEvents
@@ -505,7 +519,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1398
Private
checkAndEmitTaskExecutionEvents
@@ -513,7 +527,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1386
Private
checkAndEmitTaskQueuingEvents
@@ -521,7 +535,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1392
Protected
checkDynamicPoolSize
@@ -536,7 +550,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:187
Private
checkFilePath
@@ -549,7 +563,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:557
Private
checkNumberOfWorkers
@@ -583,7 +597,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:169
Private
checkPoolOptions
@@ -596,7 +610,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:213
Private
checkValidTasksQueueOptions
@@ -609,7 +623,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:296
Private
checkValidWorkerChoiceStrategy
@@ -622,7 +636,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:242
Private
checkValidWorkerChoiceStrategyOptions
@@ -635,7 +649,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:252
Private
chooseWorkerNode
@@ -648,7 +662,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1016
Protected
createAndSetupDynamicWorkerNode
@@ -660,7 +674,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1106
Protected
createAndSetupWorkerNode
@@ -672,7 +686,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1062
Protected
Abstract
createWorker
@@ -684,7 +698,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1055
Private
dequeueTask
@@ -697,7 +711,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1488
+Defined in src/pools/abstract-pool.ts:804
Protected
Abstract
destroyWorkerNode
@@ -728,32 +742,32 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:835
enableTasksQueue
- enableTasksQueue(enable, tasksQueueOptions?): void
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:1358
Private
handleWorkerReadyResponse
@@ -930,7 +944,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1344
Private
hasBackPressure
@@ -938,7 +952,7 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:1461
hasWorkerNodeBackPressure
+Defined in src/pools/abstract-pool.ts:1454
Protected
internalBusy
@@ -971,7 +985,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:692
Protected
Abstract
isMain
@@ -982,7 +996,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:850
+Defined in src/pools/abstract-pool.ts:712
Private
redistributeQueuedTasks
@@ -1008,7 +1022,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1207
Protected
Abstract
registerWorkerMessageListener
@@ -1048,7 +1062,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1150
Private
removeWorkerNode
@@ -1067,7 +1081,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1445
Protected
sendKillMessageToWorker
@@ -1082,7 +1096,7 @@ Can be overridden.
workerId: number
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:814
Protected
Abstract
sendStartupMessageToWorker
@@ -1101,7 +1115,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1187
Private
sendStatisticsMessageToWorker
@@ -1120,7 +1134,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1194
Protected
Abstract
sendToWorker
@@ -1149,27 +1163,40 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1044
setTasksQueueOptions
- setTasksQueueOptions(tasksQueueOptions): void
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:976
Private
updateRunTimeWorkerUsage
@@ -1309,7 +1379,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:949
Private
updateTaskStatisticsWorkerUsage
@@ -1324,7 +1394,22 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:931
+
+Private
updateTaskStolenStatisticsWorkerUsage
+
+- updateTaskStolenStatisticsWorkerUsage(workerNodeKey, taskName): void
+-
+
+
Parameters
+
+-
+
workerNodeKey: number
+-
+
taskName: string
+Returns void
Private
updateWaitTimeWorkerUsage
@@ -1339,7 +1424,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:963
Protected
workerListener
@@ -1366,20 +1451,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1326
+
-
\ 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