X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=905e085b6ed963eb2e2a81ee9ea6fc6774756b6f;hb=5543cb1ca8011b99a67fcd5fd3a7a5c2b1c4a85e;hp=2fe2f7cd195f2bbd6499945eb63d4dad225ffc0c;hpb=16f3605c35d8a2ef293a4382c6e846dc27915b4a;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 2fe2f7cd..905e085b 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,13 +1,13 @@
-
AbstractPool | poolifier - v2.6.30
@@ -49,32 +49,34 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:64
- 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 +201,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:126
Properties
@@ -195,18 +211,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:73
Protected
Readonly
filePath
filePath: string
@@ -214,7 +230,7 @@
+
Defined in src/pools/abstract-pool.ts:128
Protected
Optional
Readonly
max
max?: number
@@ -222,7 +238,7 @@
+
Defined in src/pools/abstract-pool.ts:97
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -230,7 +246,7 @@
+Defined in src/pools/abstract-pool.ts:127
Protected
Readonly
opts
@@ -238,11 +254,11 @@
+
Defined in src/pools/abstract-pool.ts:129
Protected
promiseResponseMap
-
+
Defined in src/pools/abstract-pool.ts:117
+
+Private
started
+started: boolean
+
+
-Private
Readonly
starting
+Private
starting
starting: boolean
+
Defined in src/pools/abstract-pool.ts:113
+
+Private
Readonly
taskFunctions
+
+
+
Protected
workerChoiceStrategyContext
@@ -275,7 +311,7 @@
+
Defined in src/pools/abstract-pool.ts:88
Readonly
Internal
workerNodes
@@ -284,7 +320,7 @@
+
Defined in src/pools/abstract-pool.ts:70
Protected
full
@@ -310,7 +346,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:645
+
Defined in src/pools/abstract-pool.ts:265
Protected
maxSize
@@ -333,7 +369,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:478
Protected
minSize
@@ -344,7 +380,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:471
Private
ready
@@ -355,7 +391,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:423
Protected
Abstract
type
@@ -367,7 +403,7 @@
Returns "fixed" | "dynamic"
+
Defined in src/pools/abstract-pool.ts:461
+
Defined in src/pools/abstract-pool.ts:440
Protected
Abstract
worker
@@ -390,9 +426,40 @@
Returns "thread" | "cluster"
+
Defined in src/pools/abstract-pool.ts:466
+Defined in src/pools/abstract-pool.ts:1587
Protected
afterTaskExecutionHook
@@ -439,7 +506,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1026
Protected
afterWorkerNodeSetup
@@ -459,7 +526,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1337
Protected
beforeTaskExecutionHook
@@ -484,7 +551,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:996
Private
buildTasksQueueOptions
@@ -497,7 +564,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:594
Private
checkAndEmitDynamicWorkerCreationEvents
@@ -505,7 +572,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1562
Private
checkAndEmitTaskExecutionEvents
@@ -513,7 +580,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1550
Private
checkAndEmitTaskQueuingEvents
@@ -521,35 +588,7 @@ Can be overridden.
-
Returns void
-
-Protected
checkDynamicPoolSize
-
-- checkDynamicPoolSize(min, max): void
--
-
-
Parameters
-
--
-
min: number
--
-
max: number
-Returns void
-
-Private
checkFilePath
-
-- checkFilePath(filePath): void
--
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:1556
Private
checkMessageWorkerId
+Defined in src/pools/abstract-pool.ts:488
Private
checkNumberOfWorkers
@@ -583,7 +622,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:170
Private
checkPoolOptions
@@ -596,33 +635,7 @@ Can be overridden.
Returns void
-
-Private
checkValidTasksQueueOptions
-
-- checkValidTasksQueueOptions(tasksQueueOptions): void
--
-
-
Returns void
-
-Private
checkValidWorkerChoiceStrategy
-
-- checkValidWorkerChoiceStrategy(workerChoiceStrategy): void
--
-
-
Parameters
-
--
-
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:188
Private
checkValidWorkerChoiceStrategyOptions
@@ -635,7 +648,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:217
Private
chooseWorkerNode
@@ -648,7 +661,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1153
Protected
createAndSetupDynamicWorkerNode
@@ -660,7 +673,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1243
Protected
createAndSetupWorkerNode
@@ -672,7 +685,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1199
Protected
Abstract
createWorker
@@ -684,7 +697,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1192
+
+Private
deleteTaskFunctionWorkerUsages
+
+- deleteTaskFunctionWorkerUsages(name): void
+-
+
+
Returns void
Private
dequeueTask
@@ -697,7 +723,47 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1652
+
+Protected
Abstract
deregisterWorkerMessageListener
+
+- deregisterWorkerMessageListener<Message>(workerNodeKey, listener): void
+-
+
+
+
+
Parameters
+
+-
+
workerNodeKey: number
+
+
+-
+
listener: ((message) => void)
+
+
+
+-
+
+- (message): void
+-
+
+
Returns void
+Returns void
+
+Defined in src/pools/abstract-pool.ts:934
Protected
Abstract
destroyWorkerNode
@@ -728,32 +794,32 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:972
enableTasksQueue
- enableTasksQueue(enable, tasksQueueOptions?): void
-
-
@@ -904,7 +970,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:519
Private
handleTaskExecutionResponse
@@ -917,7 +983,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1522
Private
handleWorkerReadyResponse
@@ -930,7 +996,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1506
Private
hasBackPressure
@@ -938,7 +1004,28 @@ Can be overridden.
-
Returns boolean
+Defined in src/pools/abstract-pool.ts:1625
+
hasWorkerNodeBackPressure
+Defined in src/pools/abstract-pool.ts:1618
Protected
internalBusy
@@ -971,7 +1058,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:661
Protected
Abstract
isMain
@@ -982,20 +1069,20 @@ Can be overridden.
Returns boolean
-
+
+Defined in src/pools/abstract-pool.ts:829
Private
redistributeQueuedTasks
@@ -1008,7 +1095,47 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1380
+
+Protected
Abstract
registerOnceWorkerMessageListener
+
+- registerOnceWorkerMessageListener<Message>(workerNodeKey, listener): void
+-
+
+
+
+
Parameters
+
+-
+
workerNodeKey: number
+
+
+-
+
listener: ((message) => void)
+
+
+
+-
+
+- (message): void
+-
+
+
Returns void
+Returns void
+
Protected
Abstract
registerWorkerMessageListener
@@ -1048,7 +1175,28 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1298
+
Private
removeWorkerNode
@@ -1067,22 +1215,20 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1609
Protected
sendKillMessageToWorker
-- sendKillMessageToWorker(workerNodeKey, workerId): Promise<void>
+- sendKillMessageToWorker(workerNodeKey): Promise<void>
-
Parameters
-
-
workerNodeKey: number
--
-
workerId: number
+workerNodeKey: number
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:944
Protected
Abstract
sendStartupMessageToWorker
@@ -1101,7 +1247,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1361
Private
sendStatisticsMessageToWorker
@@ -1120,7 +1266,35 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1368
+
+Private
sendTaskFunctionOperationToWorker
+
+- sendTaskFunctionOperationToWorker(workerNodeKey, message): Promise<boolean>
+-
+
+
Parameters
+
+-
+
workerNodeKey: number
+-
+
+Returns Promise<boolean>
+
+Private
sendTaskFunctionOperationToWorkers
+
+- sendTaskFunctionOperationToWorkers(message): Promise<boolean>
+-
+
+
Returns Promise<boolean>
Protected
Abstract
sendToWorker
@@ -1149,27 +1323,77 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1181
+
+setDefaultTaskFunction
+
+
+Private
setTaskStealing
+
+- setTaskStealing(): void
+-
+
Returns void
setTasksQueueOptions
- setTasksQueueOptions(tasksQueueOptions): void
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:1113
Private
updateRunTimeWorkerUsage
@@ -1309,7 +1592,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1086
Private
updateTaskStatisticsWorkerUsage
@@ -1324,7 +1607,22 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1068
+
+Private
updateTaskStolenStatisticsWorkerUsage
+
+- updateTaskStolenStatisticsWorkerUsage(workerNodeKey, taskName): void
+-
+
+
Parameters
+
+-
+
workerNodeKey: number
+-
+
taskName: string
+Returns void
Private
updateWaitTimeWorkerUsage
@@ -1339,7 +1637,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:1100
Protected
workerListener
@@ -1366,20 +1664,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1488
+
-
\ 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