X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=072c9da05dae4cb0411cc9c601675033feef32ac;hb=dd7f9381792ec728f9cd87ef7a0df6b2893db77e;hp=2fe2f7cd195f2bbd6499945eb63d4dad225ffc0c;hpb=0676e5d32c8f8ee5c5b7f5998f4973b0a276460f;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 2fe2f7cd..072c9da0 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:65
-
+
Constructors
-constructor
+
Properties
-emitter?
+
Accessors
-busy
+
Constructors
constructor constructor
new < Worker , Data , Response > ( numberOfWorkers , filePath , opts ) : AbstractPool < Worker , Data , Response >
@@ -185,28 +202,29 @@
Returns AbstractPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:127
Protected Optional Readonly max max ?: number
@@ -222,7 +240,7 @@
+
Defined in src/pools/abstract-pool.ts:79
Protected Readonly number number : number
@@ -230,7 +248,7 @@
+
Defined in src/pools/abstract-pool.ts:128
Protected Readonly opts
+
Defined in src/pools/abstract-pool.ts:130
Protected promise
+
Defined in src/pools/abstract-pool.ts:118
+
Private started started : boolean
+
+Private Readonly starting Private starting starting : boolean
+
Defined in src/pools/abstract-pool.ts:114
+
Private Readonly task Protected worker
+Defined in src/pools/abstract-pool.ts:94
Readonly Internal worker
+
Defined in src/pools/abstract-pool.ts:71
Protected full
@@ -310,7 +348,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:662
+
Defined in src/pools/abstract-pool.ts:272
Protected max
@@ -333,7 +371,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:485
Protected min
@@ -344,7 +382,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:478
Private ready
@@ -355,7 +393,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:430
Protected Abstract type
@@ -367,7 +405,7 @@
Returns "fixed" | "dynamic"
+
Defined in src/pools/abstract-pool.ts:468
+
Defined in src/pools/abstract-pool.ts:447
Protected Abstract worker
@@ -390,9 +428,40 @@
Returns "thread" | "cluster"
+
Defined in src/pools/abstract-pool.ts:473
+
Defined in src/pools/abstract-pool.ts:1614
Protected after
@@ -439,7 +508,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1044
Protected after
@@ -459,7 +528,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1355
Protected before
@@ -484,7 +553,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1014
Private build
@@ -497,7 +566,7 @@ Can be overridden.
+
Defined in src/pools/abstract-pool.ts:601
Private check
@@ -505,7 +574,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1589
Private check
@@ -513,7 +582,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1577
Private check
@@ -521,35 +590,7 @@ Can be overridden.
Returns void
-
Protected check
-check ( min , max ) : void
-
-
Parameters
-
-
-min : number
-
-max : number Returns void
-
Private check
-check ( filePath ) : void
-
-Returns void
+
Defined in src/pools/abstract-pool.ts:1583
Private check
@@ -561,7 +602,7 @@ Can be overridden.
Parameters
@@ -570,7 +611,7 @@ Can be overridden.
Throws https://nodejs.org/api/errors.html#class-error If the worker id is invalid.
+Defined in src/pools/abstract-pool.ts:495
Private check
@@ -583,7 +624,7 @@ Can be overridden.
numberOfWorkers : number
Returns void Defined in src/pools/abstract-pool.ts:171
Private check
@@ -596,33 +637,7 @@ Can be overridden.
Returns void Private check
-check ( tasksQueueOptions ) : void
-
-Returns void Private check
-check ( 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:189
Private check
@@ -635,7 +650,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:218
Private choose
@@ -648,7 +663,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1171
Protected create
@@ -660,7 +675,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1261
Protected create
@@ -672,7 +687,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1217
Protected Abstract create
@@ -684,7 +699,20 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1210
+Private delete
+delete ( name ) : void
+
+Returns void Private dequeue
@@ -697,7 +725,47 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data > Defined in src/pools/abstract-pool.ts:1679
+Protected Abstract deregister
+deregister < Message > ( workerNodeKey , listener ) : void
+
+
+
+
Parameters
+
+
+workerNodeKey : number
+
+listener : ( ( message ) => void )
+
+
+( message ) : void
+
+Returns void Returns void
+ Defined in src/pools/abstract-pool.ts:951
Protected Abstract destroy
@@ -728,32 +796,32 @@ Can be overridden.
Returns Promise < void >
Defined in src/pools/abstract-pool.ts:990
enable
enable ( enable , tasksQueueOptions ? ) : void
-
@@ -904,7 +972,33 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:526
+Private Readonly handle
+handle ( event ) : void
+
+
Parameters
+
+
+event : CustomEvent < WorkerNodeEventDetail > Returns void Private Readonly handle
+handle ( event ) : void
+
+
Parameters
+
+
+event : CustomEvent < WorkerNodeEventDetail > Returns void Private handle
@@ -917,7 +1011,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1549
Private handle
@@ -930,7 +1024,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1533
Private has
@@ -938,7 +1032,28 @@ Can be overridden.
Returns boolean Defined in src/pools/abstract-pool.ts:1652
+
has Defined in src/pools/abstract-pool.ts:1645
+Private initialize
+initialize ( ) : void
+Returns void Protected internal
@@ -971,7 +1094,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:678
Protected Abstract is
@@ -982,20 +1105,20 @@ Can be overridden.
Returns boolean
Defined in src/pools/abstract-pool.ts:846
Private redistribute
@@ -1008,7 +1131,47 @@ Can be overridden.
workerNodeKey : number
Returns void Defined in src/pools/abstract-pool.ts:1405
+Protected Abstract register
+register < Message > ( workerNodeKey , listener ) : void
+
+
+
+
Parameters
+
+
+workerNodeKey : number
+
+listener : ( ( message ) => void )
+
+
+( message ) : void
+
+Returns void Returns void
+ Protected Abstract register
@@ -1048,7 +1211,28 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1316
+
Private remove
@@ -1067,22 +1251,20 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1636
Protected send
-send ( workerNodeKey , workerId ) : Promise < void > send ( workerNodeKey ) : Promise < void >
Parameters
-workerNodeKey : number
-
-workerId : number
+workerNodeKey : number
Returns Promise < void > Defined in src/pools/abstract-pool.ts:962
Protected Abstract send
@@ -1101,7 +1283,7 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1386
Private send
@@ -1120,7 +1302,35 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1393
+Private send
+send ( workerNodeKey , message ) : Promise < boolean >
+
+
Parameters
+
+
+workerNodeKey : number
+
+ Returns Promise < boolean > Private send
+send ( message ) : Promise < boolean >
+
+Returns Promise < boolean > Protected Abstract send
@@ -1149,27 +1359,77 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1199
+set Private set
+set ( ) : void
+Returns void set
set ( tasksQueueOptions ) : void
-
Returns void Defined in src/pools/abstract-pool.ts:1131
Private update
@@ -1309,7 +1602,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1104
Private update
@@ -1324,7 +1617,22 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1086
+Private update
+update ( workerNodeKey , taskName ) : void
+
+
Parameters
+
+
+workerNodeKey : number
+
+taskName : string Returns void Private update
@@ -1339,39 +1647,28 @@ Can be overridden.
task : Task < Data >
Returns void Protected worker poolifier - v3.0.1
\ No newline at end of file
+Generated using TypeDoc
+
Emitter on which events can be listened to.
+
+OptionalemitterEvent emitter integrated with async resource on which events can be listened to. +The async tracking tooling identifier is
poolifier:<PoolType>-<WorkerType>-pool.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).ProtectedReadonlyfile