X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=60e3c607794b436d8df80a4558cc8b5d41771dd4;hb=1b27b0580ef80da95449c262682015a6da19e226;hp=be753f26c66d6837b8e47043f8cb866625b74dfd;hpb=4445abb25ec4c9d80985ca93c65762a6c892a852;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index be753f26..60e3c607 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,13 +1,13 @@
-AbstractPool | poolifier - v2.6.31
@@ -49,32 +49,34 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:66
-
+
Constructors
-constructor
+
Properties
-emitter?
+
Accessors
-busy
+
Constructors
constructor constructor
new < Worker , Data , Response > ( numberOfWorkers , filePath , opts ) : AbstractPool < Worker , Data , Response >
@@ -185,28 +203,29 @@
Returns AbstractPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:128
Protected Optional Readonly max max ?: number
@@ -222,7 +241,7 @@
+
Defined in src/pools/abstract-pool.ts:80
Protected Readonly number number : number
@@ -230,7 +249,7 @@
+
Defined in src/pools/abstract-pool.ts:129
Protected Readonly opts
+
Defined in src/pools/abstract-pool.ts:131
Protected promise
+
Defined in src/pools/abstract-pool.ts:119
+
Private started started : boolean
+
+Private Readonly starting Private starting starting : boolean
+
Defined in src/pools/abstract-pool.ts:115
+
Private Readonly task Protected worker
+Defined in src/pools/abstract-pool.ts:95
Readonly Internal worker
+
Defined in src/pools/abstract-pool.ts:72
Protected full
@@ -310,7 +349,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:660
+
Defined in src/pools/abstract-pool.ts:273
Protected max
@@ -333,7 +372,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:486
Protected min
@@ -344,7 +383,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:479
Private ready
@@ -355,7 +394,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:431
Protected Abstract type
@@ -367,7 +406,7 @@
Returns "fixed" | "dynamic"
+
Defined in src/pools/abstract-pool.ts:469
+
Defined in src/pools/abstract-pool.ts:448
Protected Abstract worker
@@ -390,9 +429,40 @@
Returns "thread" | "cluster"
+
Defined in src/pools/abstract-pool.ts:474
+
Defined in src/pools/abstract-pool.ts:1619
Protected after
@@ -439,7 +509,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1043
Protected after
@@ -459,7 +529,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1356
Protected before
@@ -484,7 +554,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1013
Private build
@@ -497,7 +567,7 @@ Can be overridden.
+
Defined in src/pools/abstract-pool.ts:599
Private check
@@ -505,7 +575,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1594
Private check
@@ -513,7 +583,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1582
Private check
@@ -521,35 +591,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:1588
Private check
@@ -561,7 +603,7 @@ Can be overridden.
Parameters
@@ -570,7 +612,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:496
Private check
@@ -583,7 +625,7 @@ Can be overridden.
numberOfWorkers : number
Returns void Defined in src/pools/abstract-pool.ts:172
Private check
@@ -596,33 +638,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:190
Private check
@@ -635,7 +651,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:219
Private choose
@@ -648,7 +664,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1170
Protected create
@@ -660,7 +676,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1260
Protected create
@@ -672,7 +688,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1216
Protected Abstract create
@@ -684,7 +700,20 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1209
+Private delete
+delete ( name ) : void
+
+Returns void Private dequeue
@@ -697,7 +726,47 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data > Defined in src/pools/abstract-pool.ts:1688
+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:949
Protected Abstract destroy
@@ -728,32 +797,32 @@ Can be overridden.
Returns Promise < void >
Defined in src/pools/abstract-pool.ts:989
enable
enable ( enable , tasksQueueOptions ? ) : void
-
-The worker information.
+The worker information.
Defined in src/pools/abstract-pool.ts:1608
Private get
@@ -884,7 +966,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:512
Private get
@@ -896,7 +978,7 @@ Can be overridden.
Parameters
-workerId : number workerId : undefined | number
@@ -904,7 +986,33 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:524
+Private Readonly handle
+handle ( event ) : void
+
+Returns void Private Readonly handle
+handle ( event ) : void
+
+Returns void Private handle
@@ -917,7 +1025,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1554
Private handle
@@ -930,7 +1038,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1534
Private has
@@ -938,7 +1046,28 @@ Can be overridden.
Returns boolean Defined in src/pools/abstract-pool.ts:1661
+
has Defined in src/pools/abstract-pool.ts:1654
+Private initialize
+initialize ( ) : void
+Returns void Protected internal
@@ -971,7 +1108,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:676
Protected Abstract is
@@ -982,20 +1119,20 @@ Can be overridden.
Returns boolean
Defined in src/pools/abstract-pool.ts:844
Private redistribute
@@ -1008,7 +1145,47 @@ Can be overridden.
workerNodeKey : number
Returns void Defined in src/pools/abstract-pool.ts:1406
+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 +1225,28 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1317
+
Private remove
@@ -1067,22 +1265,20 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1641
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:960
Protected Abstract send
@@ -1101,7 +1297,7 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1387
Private send
@@ -1120,7 +1316,35 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1394
+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 +1373,77 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1198
+set Private set
+set ( ) : void
+Returns void set
set ( tasksQueueOptions ) : void
-
Returns void Defined in src/pools/abstract-pool.ts:1130
Private update
@@ -1309,7 +1616,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1103
Private update
@@ -1324,7 +1631,22 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1085
+Private update
+update ( workerNodeKey , taskName ) : void
+
+
Parameters
+
+
+workerNodeKey : number
+
+taskName : string Returns void Private update
@@ -1339,39 +1661,28 @@ Can be overridden.
task : Task < Data >
Returns void Protected worker poolifier - v3.0.5
\ 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