X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=86fada26adb28db38824ca5ecf87c2b5d236b18c;hb=ef29303558d4caf5ff412db9579ea28346b77f3f;hp=8b279fef929856d2c4c298f1a55104b348cb44ad;hpb=0e16e60a89029abe61cda7ba293c036298cced05;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 8b279fef..86fada26 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,13 +1,13 @@
-
AbstractPool | poolifier - v2.6.26
@@ -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>
-
@@ -180,7 +191,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:114
Protected
Readonly
filePath
filePath: string
@@ -207,7 +220,15 @@
+
Defined in src/pools/abstract-pool.ts:116
+
+Protected
Optional
Readonly
max
+max?: number
+
+
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -215,7 +236,7 @@
+
Defined in src/pools/abstract-pool.ts:115
Protected
Readonly
opts
@@ -223,11 +244,11 @@
+
Defined in src/pools/abstract-pool.ts:117
Protected
promiseResponseMap
-
-
-Private
Readonly
starting
-starting: boolean
-
+
Defined in src/pools/abstract-pool.ts:1423
Protected
afterTaskExecutionHook
@@ -432,7 +453,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:889
Protected
afterWorkerNodeSetup
@@ -452,7 +473,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1163
Protected
beforeTaskExecutionHook
@@ -477,7 +498,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:859
Private
buildTasksQueueOptions
@@ -490,15 +511,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:1392
Protected
checkDynamicPoolSize
@@ -513,7 +550,7 @@ Can be overridden.
max: number
Returns void
+
Defined in src/pools/abstract-pool.ts:187
Private
checkFilePath
@@ -526,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
@@ -560,7 +597,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:169
Private
checkPoolOptions
@@ -573,7 +610,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:213
Private
checkValidTasksQueueOptions
@@ -586,7 +623,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:296
Private
checkValidWorkerChoiceStrategy
@@ -599,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
@@ -612,7 +649,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:252
Private
chooseWorkerNode
@@ -625,7 +662,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1016
Protected
createAndSetupDynamicWorkerNode
@@ -637,7 +674,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1106
Protected
createAndSetupWorkerNode
@@ -649,7 +686,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1062
Protected
Abstract
createWorker
@@ -661,7 +698,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1055
Private
dequeueTask
@@ -674,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
@@ -705,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
@@ -907,7 +944,36 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1344
+
+Private
hasBackPressure
+
+- hasBackPressure(): boolean
+-
+
Returns boolean
+
+hasWorkerNodeBackPressure
+
Protected
internalBusy
@@ -919,7 +985,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:692
Protected
Abstract
isMain
@@ -930,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
@@ -956,7 +1022,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1207
Protected
Abstract
registerWorkerMessageListener
@@ -996,7 +1062,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1150
Private
removeWorkerNode
@@ -1015,7 +1081,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1445
Protected
sendKillMessageToWorker
@@ -1030,7 +1096,7 @@ Can be overridden.
workerId: number
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:814
Protected
Abstract
sendStartupMessageToWorker
@@ -1049,7 +1115,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1187
Private
sendStatisticsMessageToWorker
@@ -1068,7 +1134,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1194
Protected
Abstract
sendToWorker
@@ -1097,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
@@ -1237,7 +1379,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:949
Private
updateTaskStatisticsWorkerUsage
@@ -1252,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
@@ -1267,7 +1424,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:963
Protected
workerListener
@@ -1294,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
Emitter on which events can be listened to.
Events that can currently be listened to:
-
-
+
+
+
+
'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.'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.'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).