X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=86fada26adb28db38824ca5ecf87c2b5d236b18c;hb=ef29303558d4caf5ff412db9579ea28346b77f3f;hp=aff9850dd46ceb55e6088a5de0ea9e4d8b744410;hpb=0fa1d6f0433baf6ff3f67fefdbdf610612a4f3e9;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index aff9850d..86fada26 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,13 +1,13 @@
-
AbstractPool | poolifier - v2.6.32
@@ -49,19 +49,19 @@
- 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>
-
@@ -188,7 +191,7 @@
Returns AbstractPool<Worker, Data, Response>
+
Defined in src/pools/abstract-pool.ts:114
Protected
Readonly
filePath
filePath: string
@@ -217,7 +220,7 @@
+
Defined in src/pools/abstract-pool.ts:116
Protected
Optional
Readonly
max
max?: number
@@ -225,7 +228,7 @@
+
Defined in src/pools/abstract-pool.ts:92
Protected
Readonly
numberOfWorkers
numberOfWorkers: number
@@ -233,7 +236,7 @@
+
Defined in src/pools/abstract-pool.ts:115
Protected
Readonly
opts
@@ -241,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
@@ -270,15 +273,15 @@
+
Defined in src/pools/abstract-pool.ts:97
-Private
Readonly
starting
+Private
starting
starting: boolean
+
Defined in src/pools/abstract-pool.ts:101
Protected
workerChoiceStrategyContext
@@ -286,7 +289,7 @@
+
Defined in src/pools/abstract-pool.ts:83
Readonly
Internal
workerNodes
@@ -295,7 +298,7 @@
+
Defined in src/pools/abstract-pool.ts:65
Protected
full
@@ -321,7 +324,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:676
+
Defined in src/pools/abstract-pool.ts:334
Protected
maxSize
@@ -344,7 +347,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:547
Protected
minSize
@@ -355,7 +358,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:540
Private
ready
@@ -366,7 +369,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:492
Protected
Abstract
type
@@ -378,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
@@ -401,7 +404,7 @@
Returns "thread" | "cluster"
+
Defined in src/pools/abstract-pool.ts:535
+Defined in src/pools/abstract-pool.ts:1423
Protected
afterTaskExecutionHook
@@ -450,7 +453,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:889
Protected
afterWorkerNodeSetup
@@ -470,7 +473,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1163
Protected
beforeTaskExecutionHook
@@ -495,7 +498,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:859
Private
buildTasksQueueOptions
@@ -508,7 +511,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:657
Private
checkAndEmitDynamicWorkerCreationEvents
@@ -516,7 +519,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1398
Private
checkAndEmitTaskExecutionEvents
@@ -524,7 +527,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1386
Private
checkAndEmitTaskQueuingEvents
@@ -532,7 +535,7 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1392
Protected
checkDynamicPoolSize
@@ -547,7 +550,7 @@ Can be overridden.
max: number
Returns void
+Defined in src/pools/abstract-pool.ts:187
Private
checkFilePath
@@ -560,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
@@ -594,7 +597,7 @@ Can be overridden.
numberOfWorkers: number
Returns void
+Defined in src/pools/abstract-pool.ts:169
Private
checkPoolOptions
@@ -607,7 +610,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:213
Private
checkValidTasksQueueOptions
@@ -620,7 +623,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:296
Private
checkValidWorkerChoiceStrategy
@@ -633,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
@@ -646,7 +649,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:252
Private
chooseWorkerNode
@@ -659,7 +662,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1016
Protected
createAndSetupDynamicWorkerNode
@@ -671,7 +674,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1106
Protected
createAndSetupWorkerNode
@@ -683,7 +686,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1062
Protected
Abstract
createWorker
@@ -695,7 +698,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1055
Private
dequeueTask
@@ -708,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
@@ -739,7 +742,7 @@ Can be overridden.
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:835
+Defined in src/pools/abstract-pool.ts:628
Private
enqueueTask
@@ -779,7 +782,7 @@ Can be overridden.
task: Task<Data>
Returns number
+Defined in src/pools/abstract-pool.ts:1482
+Defined in src/pools/abstract-pool.ts:733
Private
executeTask
@@ -834,7 +837,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1476
Protected
flushTasksQueue
@@ -847,7 +850,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1496
Private
flushTasksQueues
@@ -855,11 +858,11 @@ Can be overridden.
-
Returns void
+Defined in src/pools/abstract-pool.ts:1506
Protected
getWorkerInfo
-- getWorkerInfo(workerNodeKey): undefined | WorkerInfo
+- getWorkerInfo(workerNodeKey): WorkerInfo
-
@@ -871,11 +874,11 @@ Can be overridden.
-The worker information.
+The worker information.
+Defined in src/pools/abstract-pool.ts:1412
Private
getWorkerNodeKeyByWorker
@@ -895,7 +898,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:576
Private
getWorkerNodeKeyByWorkerId
@@ -915,7 +918,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:588
Private
handleTaskExecutionResponse
@@ -928,7 +931,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1358
Private
handleWorkerReadyResponse
@@ -941,7 +944,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:1344
Private
hasBackPressure
@@ -949,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
@@ -982,7 +985,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:692
Protected
Abstract
isMain
@@ -993,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
@@ -1019,7 +1022,7 @@ Can be overridden.
workerNodeKey: number
Returns void
+Defined in src/pools/abstract-pool.ts:1207
Protected
Abstract
registerWorkerMessageListener
@@ -1059,7 +1062,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1150
Private
removeWorkerNode
@@ -1078,7 +1081,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1445
Protected
sendKillMessageToWorker
@@ -1093,7 +1096,7 @@ Can be overridden.
workerId: number
Returns Promise<void>
+Defined in src/pools/abstract-pool.ts:814
Protected
Abstract
sendStartupMessageToWorker
@@ -1112,7 +1115,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1187
Private
sendStatisticsMessageToWorker
@@ -1131,7 +1134,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1194
Protected
Abstract
sendToWorker
@@ -1160,20 +1163,7 @@ Can be overridden.
Returns void
-
-Private
setTasksQueueMaxSize
-
-- setTasksQueueMaxSize(queueMaxSize): void
--
-
-
Returns void
+Defined in src/pools/abstract-pool.ts:1044
+Defined in src/pools/abstract-pool.ts:640
+
+Private
setTasksQueueSize
+
+- setTasksQueueSize(size): void
+-
+
+
Returns void
+Defined in src/pools/abstract-pool.ts:595
setWorkerChoiceStrategyOptions
+Defined in src/pools/abstract-pool.ts:614
Protected
setupHook
@@ -1250,7 +1253,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:843
Private
shallCreateDynamicWorker
@@ -1262,7 +1265,20 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1033
+
+Private
shallExecuteTask
+
+- shallExecuteTask(workerNodeKey): boolean
+-
+
+
Returns boolean
Private
shallUpdateTaskFunctionWorkerUsage
@@ -1282,15 +1298,32 @@ Can be overridden.
-
+
+start
+
+- start(): void
+-
+
+
Returns void
+
+
+Private
taskStealingOnEmptyQueue
-- startPool(): void
+- taskStealingOnEmptyQueue(workerId): void
-
+
Returns void
+Defined in src/pools/abstract-pool.ts:1251
Private
tasksQueueSize
@@ -1303,7 +1336,7 @@ Can be overridden.
workerNodeKey: number
Returns number
+Defined in src/pools/abstract-pool.ts:1492
Private
tasksStealingOnBackPressure
@@ -1316,7 +1349,7 @@ Can be overridden.
workerId: number
Returns void
+Defined in src/pools/abstract-pool.ts:1283
Private
updateEluWorkerUsage
@@ -1331,7 +1364,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:976
Private
updateRunTimeWorkerUsage
@@ -1346,7 +1379,7 @@ Can be overridden.
message: MessageValue<Response, unknown>
Returns void
+Defined in src/pools/abstract-pool.ts:949
Private
updateTaskStatisticsWorkerUsage
@@ -1361,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
@@ -1376,7 +1424,7 @@ Can be overridden.
task: Task<Data>
Returns void
+Defined in src/pools/abstract-pool.ts:963
Protected
workerListener
@@ -1403,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