X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=57b75a1a6da1adfb6f25fa46a5518a8e1ce7ed62;hb=70ceef6e16bec1f1d12754b2f5e8d71c91ca06a7;hp=e0ce9367d8156b3d8f65f10367f605703ed569ee;hpb=a84c4698b83aaa02b9f10e52aa9c76eff5b5871f;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index e0ce9367..57b75a1a 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,13 +1,13 @@
-AbstractPool | poolifier - v2.6.35
@@ -49,19 +49,19 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:64
-
+
Constructors
-constructor
+
Properties
-emitter?
+
Accessors
-busy
+
Constructors
constructor constructor
new < Worker , Data , Response > ( numberOfWorkers , filePath , opts ) : AbstractPool < Worker , Data , Response >
@@ -189,17 +202,18 @@
Returns AbstractPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:126
Protected Readonly number number : number
@@ -234,7 +248,7 @@
+
Defined in src/pools/abstract-pool.ts:127
Protected Readonly opts
+
Defined in src/pools/abstract-pool.ts:129
Protected promise
+
Defined in src/pools/abstract-pool.ts:117
Private started started : boolean
@@ -271,15 +285,27 @@
+
Defined in src/pools/abstract-pool.ts:109
Private Readonly starting Private starting starting : boolean
+
Defined in src/pools/abstract-pool.ts:113
+
Private Readonly task Protected worker
+Defined in src/pools/abstract-pool.ts:93
Readonly Internal worker
+
Defined in src/pools/abstract-pool.ts:70
Protected full
@@ -322,7 +348,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:651
+
Defined in src/pools/abstract-pool.ts:271
Protected max
@@ -345,7 +371,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:484
Protected min
@@ -356,7 +382,7 @@
Returns number
+
Defined in src/pools/abstract-pool.ts:477
Private ready
@@ -367,7 +393,7 @@
Returns boolean
+
Defined in src/pools/abstract-pool.ts:429
Protected Abstract type
@@ -379,7 +405,7 @@
Returns "fixed" | "dynamic"
+
Defined in src/pools/abstract-pool.ts:467
+
Defined in src/pools/abstract-pool.ts:446
Protected Abstract worker
@@ -402,9 +428,40 @@
Returns "thread" | "cluster"
+
Defined in src/pools/abstract-pool.ts:472
+
Defined in src/pools/abstract-pool.ts:1593
Protected after
@@ -451,7 +508,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1033
Protected after
@@ -471,7 +528,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1344
Protected before
@@ -496,7 +553,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1003
Private build
@@ -509,7 +566,7 @@ Can be overridden.
+
Defined in src/pools/abstract-pool.ts:600
Private check
@@ -517,7 +574,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1568
Private check
@@ -525,7 +582,7 @@ Can be overridden.
Returns void
+
Defined in src/pools/abstract-pool.ts:1556
Private check
@@ -533,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:1562
Private check
@@ -573,7 +602,7 @@ Can be overridden.
Parameters
@@ -582,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:494
Private check
@@ -595,7 +624,7 @@ Can be overridden.
numberOfWorkers : number
Returns void Defined in src/pools/abstract-pool.ts:170
Private check
@@ -608,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:188
Private check
@@ -647,7 +650,7 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:217
Private choose
@@ -660,7 +663,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1160
Protected create
@@ -672,7 +675,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1250
Protected create
@@ -684,7 +687,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1206
Protected Abstract create
@@ -696,7 +699,20 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1199
+Private delete
+delete ( name ) : void
+
+Returns void Private dequeue
@@ -709,7 +725,47 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data > Defined in src/pools/abstract-pool.ts:1658
+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:940
Protected Abstract destroy
@@ -740,7 +796,7 @@ Can be overridden.
Returns Promise < void >
Defined in src/pools/abstract-pool.ts:979
+Defined in src/pools/abstract-pool.ts:565
Private enqueue
@@ -780,7 +836,7 @@ Can be overridden.
task : Task < Data >
Returns number Defined in src/pools/abstract-pool.ts:1652
+Defined in src/pools/abstract-pool.ts:870
Private execute
@@ -835,7 +891,7 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1646
Protected flush
@@ -848,7 +904,7 @@ Can be overridden.
workerNodeKey : number
Returns void Defined in src/pools/abstract-pool.ts:1666
Private flush
@@ -856,11 +912,11 @@ Can be overridden.
Returns void Defined in src/pools/abstract-pool.ts:1676
Protected get
-get ( workerNodeKey ) : undefined | WorkerInfo get ( workerNodeKey ) : WorkerInfo
@@ -872,11 +928,11 @@ Can be overridden.
-The worker information.
+The worker information.
Defined in src/pools/abstract-pool.ts:1582
Private get
@@ -896,7 +952,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:513
Private get
@@ -908,7 +964,7 @@ Can be overridden.
Parameters
-workerId : number workerId : undefined | number
@@ -916,7 +972,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:525
Private handle
@@ -929,7 +985,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1528
Private handle
@@ -942,7 +998,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1512
Private has
@@ -950,7 +1006,28 @@ Can be overridden.
Returns boolean Defined in src/pools/abstract-pool.ts:1631
+
has Defined in src/pools/abstract-pool.ts:1624
+Private initialize
+initialize ( ) : void
+Returns void Protected internal
@@ -983,7 +1068,7 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:667
Protected Abstract is
@@ -994,20 +1079,20 @@ Can be overridden.
Returns boolean
Defined in src/pools/abstract-pool.ts:835
Private redistribute
@@ -1020,7 +1105,47 @@ Can be overridden.
workerNodeKey : number
Returns void Defined in src/pools/abstract-pool.ts:1390
+Protected Abstract register
+register < Message > ( workerNodeKey , listener ) : void
+
+
+
+
Parameters
+
+
+workerNodeKey : number
+
+listener : ( ( message ) => void )
+
+
+( message ) : void
+
+Returns void Returns void
+ Protected Abstract register
@@ -1060,7 +1185,28 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1305
+
Private remove
@@ -1079,22 +1225,20 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1615
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:951
Protected Abstract send
@@ -1113,7 +1257,7 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1371
Private send
@@ -1132,7 +1276,35 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:1378
+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
@@ -1161,20 +1333,36 @@ Can be overridden.
Returns void
Private set set
+set ( name ) : Promise < boolean >
+
+name : string
+Returns Promise < boolean > true if the default task function was set, false otherwise.
+
+Private set
+set ( ) : void
Returns void Defined in src/pools/abstract-pool.ts:620
+Defined in src/pools/abstract-pool.ts:579
+Private set
+set ( size ) : void
+
+Returns void Private set
+set ( ) : void
+Returns void Defined in src/pools/abstract-pool.ts:532
set Defined in src/pools/abstract-pool.ts:551
Protected setup
@@ -1251,7 +1460,7 @@ Can be overridden.
Returns void
Defined in src/pools/abstract-pool.ts:987
Private shall
@@ -1263,7 +1472,20 @@ Can be overridden.
Defined in src/pools/abstract-pool.ts:1177
+Private shall
+shall ( workerNodeKey ) : boolean
+
+Returns boolean Private shall
@@ -1283,15 +1505,19 @@ Can be overridden.
start
+start ( ) : void
-Returns void Defined in src/pools/abstract-pool.ts:924
Private task
@@ -1304,7 +1530,7 @@ Can be overridden.
workerId : number
Returns void Defined in src/pools/abstract-pool.ts:1430
Private tasks
@@ -1317,7 +1543,7 @@ Can be overridden.
workerNodeKey : number
Returns number Defined in src/pools/abstract-pool.ts:1662
Private tasks
@@ -1330,7 +1556,23 @@ Can be overridden.
workerId : number
Returns void Defined in src/pools/abstract-pool.ts:1458
+Private unset
+unset ( ) : void
+Returns void Private unset
+unset ( ) : void
+Returns void Private update
@@ -1345,7 +1587,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1120
Private update
@@ -1360,7 +1602,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1093
Private update
@@ -1375,7 +1617,22 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void Defined in src/pools/abstract-pool.ts:1075
+Private update
+update ( workerNodeKey , taskName ) : void
+
+
Parameters
+
+
+workerNodeKey : number
+
+taskName : string Returns void Private update
@@ -1390,39 +1647,28 @@ Can be overridden.
task : Task < Data >
Returns void Protected worker poolifier - v3.0.0
\ 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.'error': Emitted when an uncaught error occurs.ProtectedReadonlyfileProtectedOptionalReadonlymax