X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=30969c24eba5305e5ab3a9f7431500638caca2a7;hb=bfc75ccaf49d915d2b7e73c92360787b3245321a;hp=48d436c8a7e1ce36227e088badf7c1e00fb46e9f;hpb=fb8fbcfd7983c1eadc39411c9b29054e6fa97d5b;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 48d436c8..30969c24 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,13 +1,13 @@
-
AbstractPool | poolifier - v2.6.28
@@ -49,24 +49,26 @@
- IPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:60
- Index
+ Index
Constructors
-constructor
+
Properties
-emitter?
+
Accessors
-busy
+
Constructors
-constructor
+constructor
- new AbstractPool<Worker, Data, Response>(numberOfWorkers, filePath, opts): AbstractPool<Worker, Data, Response>
-
@@ -180,7 +203,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:122
Properties
@@ -190,17 +213,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 >= maximum queue size).
+
Defined in src/pools/abstract-pool.ts:69
Protected
Readonly
filePath
filePath: string
@@ -208,7 +232,15 @@
+
Defined in src/pools/abstract-pool.ts:124
+
+Protected
Optional
Readonly
max
+max?: number
+
+
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -216,7 +248,7 @@
+
Defined in src/pools/abstract-pool.ts:123
Protected
Readonly
opts
@@ -224,11 +256,11 @@
+Defined in src/pools/abstract-pool.ts:125
Protected
promiseResponseMap
-
+
Defined in src/pools/abstract-pool.ts:113
+
+Private
started
+started: boolean
+
+
-Private
Readonly
starting
+Private
starting
starting: boolean
+
Defined in src/pools/abstract-pool.ts:109
-Private
taskFunctions
-taskFunctions: string[]
-
+
Defined in src/pools/abstract-pool.ts:84
-Readonly
workerNodes
+Readonly
Internal
workerNodes
+
Defined in src/pools/abstract-pool.ts:66
Protected
full
@@ -304,7 +348,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:732
+
Defined in src/pools/abstract-pool.ts:352
-Protected
Abstract
maxSize
+Protected
maxSize
- get maxSize(): number
-
@@ -327,9 +371,9 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:565
-Protected
Abstract
minSize
+Protected
minSize
- get minSize(): number
-
@@ -338,7 +382,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:558
Private
ready
@@ -349,7 +393,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:510
Protected
Abstract
type
@@ -361,7 +405,7 @@
Returns "fixed" | "dynamic"
+
Defined in src/pools/abstract-pool.ts:548
+
Defined in src/pools/abstract-pool.ts:527
Protected
Abstract
worker
@@ -384,9 +428,40 @@
Returns "thread" | "cluster"
+
Defined in src/pools/abstract-pool.ts:553
+
Defined in src/pools/abstract-pool.ts:1624
Protected
afterTaskExecutionHook
@@ -433,7 +508,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1090
Protected
afterWorkerNodeSetup
@@ -453,7 +528,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1374
Protected
beforeTaskExecutionHook
@@ -478,7 +553,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1060
Private
buildTasksQueueOptions
@@ -491,15 +566,31 @@ Can be overridden.
-
+
+Private
checkAndEmitDynamicWorkerCreationEvents
+
+- checkAndEmitDynamicWorkerCreationEvents(): void
+-
+
Returns void
+
+Private
checkAndEmitTaskExecutionEvents
+
+- checkAndEmitTaskExecutionEvents(): void
+-
+
Returns void
+
+Private
checkAndEmitTaskQueuingEvents
-- checkAndEmitEvents(): void
+- checkAndEmitTaskQueuingEvents(): void
-
Returns void
+
Defined in src/pools/abstract-pool.ts:1593
Protected
checkDynamicPoolSize
@@ -514,7 +605,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:197
Private
checkFilePath
@@ -527,7 +618,7 @@ Can be overridden.
filePath: string
Returns void
+Defined in src/pools/abstract-pool.ts:166
Private
checkMessageWorkerId
+Defined in src/pools/abstract-pool.ts:575
Private
checkNumberOfWorkers
@@ -561,7 +652,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:179
Private
checkPoolOptions
@@ -574,7 +665,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:223
Private
checkValidTasksQueueOptions
@@ -587,7 +678,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:314
Private
checkValidWorkerChoiceStrategy
@@ -600,7 +691,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:254
Private
checkValidWorkerChoiceStrategyOptions
@@ -613,7 +704,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:267
Private
chooseWorkerNode
@@ -626,7 +717,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1217
Protected
createAndSetupDynamicWorkerNode
@@ -638,7 +729,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1307
Protected
createAndSetupWorkerNode
@@ -650,7 +741,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1263
Protected
Abstract
createWorker
@@ -662,7 +753,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1256
+
+Private
deleteTaskFunctionWorkerUsages
+
+- deleteTaskFunctionWorkerUsages(name): void
+-
+
+
Returns void
Private
dequeueTask
@@ -675,7 +779,7 @@ Can be overridden.
workerNodeKey: number
Returns undefined | Task<Data>
+Defined in src/pools/abstract-pool.ts:1689
+Defined in src/pools/abstract-pool.ts:1000
Protected
Abstract
destroyWorkerNode
@@ -706,32 +810,32 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:1036
enableTasksQueue
- enableTasksQueue(enable, tasksQueueOptions?): void
-
-
@@ -882,7 +986,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:606
Private
handleTaskExecutionResponse
@@ -895,7 +999,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1559
Private
handleWorkerReadyResponse
@@ -908,7 +1012,57 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1543
+
+Private
hasBackPressure
+
+- hasBackPressure(): boolean
+-
+
Returns boolean
+
+
+hasWorkerNodeBackPressure
+
Protected
internalBusy
@@ -920,7 +1074,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:748
Protected
Abstract
isMain
@@ -931,20 +1085,20 @@ Can be overridden.
Returns boolean
-
+
+Defined in src/pools/abstract-pool.ts:895
Private
redistributeQueuedTasks
@@ -957,7 +1111,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1417
Protected
Abstract
registerWorkerMessageListener
@@ -997,7 +1151,28 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1361
+
Private
removeWorkerNode
@@ -1016,22 +1191,20 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1646
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:1010
Protected
Abstract
sendStartupMessageToWorker
@@ -1050,7 +1223,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1398
Private
sendStatisticsMessageToWorker
@@ -1069,7 +1242,35 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1405
+
+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
@@ -1098,27 +1299,77 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1245
+
+setDefaultTaskFunction
+
+
+Private
setTaskStealing
+
+- setTaskStealing(): void
+-
+
Returns void
setTasksQueueOptions
- setTasksQueueOptions(tasksQueueOptions): void
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:1177
Private
updateRunTimeWorkerUsage
@@ -1238,7 +1568,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1150
Private
updateTaskStatisticsWorkerUsage
@@ -1253,7 +1583,22 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1132
+
+Private
updateTaskStolenStatisticsWorkerUsage
+
+- updateTaskStolenStatisticsWorkerUsage(workerNodeKey, taskName): void
+-
+
+
Parameters
+
+-
+
workerNodeKey: number
+-
+
taskName: string
+Returns void
Private
updateWaitTimeWorkerUsage
@@ -1268,7 +1613,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:1164
Protected
workerListener
@@ -1295,20 +1640,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1525
+
-
\ No newline at end of file
+Generated using TypeDoc
+
\ No newline at end of file
Dynamic pool maximum size property placeholder.
+