X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FAbstractPool.html;h=072c9da05dae4cb0411cc9c601675033feef32ac;hb=b2862722f44d3facf07a2e632d25d261f3dabbce;hp=57019215eab51531af8a99c7d0f472ca09bc6c9b;hpb=d93988cdbc3eb55747301602bfa03d8543223c71;p=poolifier.git
diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html
index 57019215..072c9da0 100644
--- a/docs/classes/AbstractPool.html
+++ b/docs/classes/AbstractPool.html
@@ -1,4 +1,4 @@
-
AbstractPool | poolifier - v2.7.4
+AbstractPool | poolifier - v3.0.1
@@ -49,7 +49,7 @@
IPool < Worker , Data , Response >
+
Defined in src/pools/abstract-pool.ts:65
Constructors
@@ -202,12 +202,12 @@
Returns AbstractPool < Worker , Data , Response >
+Defined in src/pools/abstract-pool.ts:127
Properties
Optional
emitter
-emitter ?: __module | EventEmitterAsyncResource
+emitter ?: EventEmitterAsyncResource
+Defined in src/pools/abstract-pool.ts:129
Protected
Optional
Readonly
max
max ?: number
@@ -240,7 +240,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:79
Protected
Readonly
number Of Workers
number Of Workers : number
@@ -248,7 +248,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:128
Protected
Readonly
opts
@@ -256,7 +256,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:130
Protected
promise Response Map
@@ -269,7 +269,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:88
Private
Readonly
start Timestamp
start Timestamp : number
@@ -277,7 +277,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:118
Private
started
started : boolean
@@ -285,7 +285,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:110
Private
starting
starting : boolean
@@ -293,7 +293,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:114
Private
Readonly
task Functions
@@ -305,7 +305,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:105
Protected
worker Choice Strategy Context
@@ -313,7 +313,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:94
Readonly
Internal
worker Nodes
@@ -322,7 +322,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:71
Accessors
@@ -336,7 +336,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns boolean
+Defined in src/pools/abstract-pool.ts:671
Protected
full
@@ -348,7 +348,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns boolean
+Defined in src/pools/abstract-pool.ts:662
info
@@ -360,7 +360,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:272
Protected
max Size
@@ -371,7 +371,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns number
+Defined in src/pools/abstract-pool.ts:485
Protected
min Size
@@ -382,7 +382,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns number
+Defined in src/pools/abstract-pool.ts:478
Private
ready
@@ -393,7 +393,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns boolean
+Defined in src/pools/abstract-pool.ts:430
Protected
Abstract
type
@@ -405,7 +405,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns "fixed" | "dynamic"
+Defined in src/pools/abstract-pool.ts:468
Private
utilization
@@ -417,7 +417,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
+Defined in src/pools/abstract-pool.ts:447
Protected
Abstract
worker
@@ -428,7 +428,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
Returns "thread" | "cluster"
+Defined in src/pools/abstract-pool.ts:473
+Defined in src/pools/abstract-pool.ts:1614
Protected
after Task Execution Hook
@@ -508,7 +508,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1044
Protected
after Worker Node Setup
@@ -528,7 +528,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1355
Protected
before Task Execution Hook
@@ -553,7 +553,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1014
Private
build Tasks Queue Options
@@ -566,7 +566,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:601
Private
check And Emit Dynamic Worker Creation Events
@@ -574,7 +574,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1589
Private
check And Emit Task Execution Events
@@ -582,7 +582,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1577
Private
check And Emit Task Queuing Events
@@ -590,7 +590,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1583
Private
check Message Worker Id
+Defined in src/pools/abstract-pool.ts:495
Private
check Number Of Workers
@@ -624,7 +624,7 @@ Can be overridden.
numberOfWorkers : number
Returns void
+Defined in src/pools/abstract-pool.ts:171
Private
check Pool Options
@@ -637,7 +637,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:189
Private
check Valid Worker Choice Strategy Options
@@ -650,7 +650,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:218
Private
choose Worker Node
@@ -663,7 +663,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1171
Protected
create And Setup Dynamic Worker Node
@@ -675,7 +675,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1261
Protected
create And Setup Worker Node
@@ -687,7 +687,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1217
Protected
Abstract
create Worker
@@ -699,7 +699,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1210
Private
delete Task Function Worker Usages
@@ -712,7 +712,7 @@ Can be overridden.
name : string
Returns void
+Defined in src/pools/abstract-pool.ts:866
Private
dequeue Task
@@ -725,7 +725,7 @@ Can be overridden.
workerNodeKey : number
Returns undefined | Task < Data >
+Defined in src/pools/abstract-pool.ts:1679
Protected
Abstract
deregister Worker Message Listener
@@ -765,7 +765,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1342
+Defined in src/pools/abstract-pool.ts:951
Protected
Abstract
destroy Worker Node
@@ -796,7 +796,7 @@ Can be overridden.
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:990
+Defined in src/pools/abstract-pool.ts:566
Private
enqueue Task
@@ -836,7 +836,7 @@ Can be overridden.
task : Task < Data >
Returns number
+Defined in src/pools/abstract-pool.ts:1673
+Defined in src/pools/abstract-pool.ts:881
Private
execute Task
@@ -891,7 +891,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1667
Protected
flush Tasks Queue
@@ -904,7 +904,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1687
Private
flush Tasks Queues
@@ -912,7 +912,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1697
Protected
get Worker Info
@@ -932,7 +932,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1603
Private
get Worker Node Key By Worker
@@ -952,7 +952,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:514
Private
get Worker Node Key By Worker Id
@@ -972,7 +972,33 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:526
+
+Private
Readonly
handle Back Pressure Event
+
+handle Back Pressure Event ( event ) : void
+
+
+
Parameters
+
+
+event : CustomEvent < WorkerNodeEventDetail >
+Returns void
+
+Private
Readonly
handle Empty Queue Event
+
+handle Empty Queue Event ( event ) : void
+
+
+
Parameters
+
+
+event : CustomEvent < WorkerNodeEventDetail >
+Returns void
Private
handle Task Execution Response
@@ -985,7 +1011,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1549
Private
handle Worker Ready Response
@@ -998,7 +1024,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1533
Private
has Back Pressure
@@ -1006,7 +1032,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1652
+Defined in src/pools/abstract-pool.ts:794
has Worker Node Back Pressure
+Defined in src/pools/abstract-pool.ts:1645
Private
initialize Event Emitter
@@ -1056,7 +1082,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:265
Protected
internal Busy
@@ -1068,7 +1094,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:678
Protected
Abstract
is Main
@@ -1079,7 +1105,7 @@ Can be overridden.
Returns boolean
+Defined in src/pools/abstract-pool.ts:1005
+Defined in src/pools/abstract-pool.ts:846
Private
redistribute Queued Tasks
@@ -1105,7 +1131,7 @@ Can be overridden.
workerNodeKey : number
Returns void
+Defined in src/pools/abstract-pool.ts:1405
Protected
Abstract
register Once Worker Message Listener
@@ -1145,7 +1171,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1329
Protected
Abstract
register Worker Message Listener
@@ -1185,7 +1211,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1316
+Defined in src/pools/abstract-pool.ts:830
Private
remove Worker Node
@@ -1225,7 +1251,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1636
Protected
send Kill Message To Worker
@@ -1238,7 +1264,7 @@ Can be overridden.
workerNodeKey : number
Returns Promise < void >
+Defined in src/pools/abstract-pool.ts:962
Protected
Abstract
send Startup Message To Worker
@@ -1257,7 +1283,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1386
Private
send Statistics Message To Worker
@@ -1276,7 +1302,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1393
Private
send Task Function Operation To Worker
@@ -1291,7 +1317,7 @@ Can be overridden.
Returns Promise < boolean >
+Defined in src/pools/abstract-pool.ts:697
Private
send Task Function Operation To Workers
@@ -1304,7 +1330,7 @@ Can be overridden.
Returns Promise < boolean >
+Defined in src/pools/abstract-pool.ts:738
Protected
Abstract
send To Worker
@@ -1333,7 +1359,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:1199
+Defined in src/pools/abstract-pool.ts:859
Private
set Task Stealing
@@ -1362,7 +1388,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:621
+Defined in src/pools/abstract-pool.ts:580
Private
set Tasks Queue Size
@@ -1395,7 +1421,7 @@ Can be overridden.
size : number
Returns void
+Defined in src/pools/abstract-pool.ts:615
Private
set Tasks Stealing On Back Pressure
@@ -1403,7 +1429,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:639
+Defined in src/pools/abstract-pool.ts:533
set Worker Choice Strategy Options
+Defined in src/pools/abstract-pool.ts:552
Protected
setup Hook
@@ -1460,7 +1486,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:998
Private
shall Create Dynamic Worker
@@ -1472,7 +1498,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1188
Private
shall Execute Task
@@ -1485,7 +1511,7 @@ Can be overridden.
workerNodeKey : number
Returns boolean
+Defined in src/pools/abstract-pool.ts:872
Private
shall Update Task Function Worker Usage
@@ -1505,7 +1531,7 @@ Can be overridden.
+Defined in src/pools/abstract-pool.ts:1077
-
-Private
task Stealing On Empty Queue
-
-task Stealing On Empty Queue ( workerId ) : void
-
-
-Returns void
+Defined in src/pools/abstract-pool.ts:935
Private
tasks Queue Size
@@ -1543,20 +1556,7 @@ Can be overridden.
workerNodeKey : number
Returns number
-
-Private
tasks Stealing On Back Pressure
-
-tasks Stealing On Back Pressure ( workerId ) : void
-
-
-Returns void
+Defined in src/pools/abstract-pool.ts:1683
Private
unset Task Stealing
@@ -1564,7 +1564,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:630
Private
unset Tasks Stealing On Back Pressure
@@ -1572,7 +1572,7 @@ Can be overridden.
Returns void
+Defined in src/pools/abstract-pool.ts:648
Private
update Elu Worker Usage
@@ -1587,7 +1587,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1131
Private
update Run Time Worker Usage
@@ -1602,7 +1602,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1104
Private
update Task Statistics Worker Usage
@@ -1617,7 +1617,7 @@ Can be overridden.
message : MessageValue < Response , unknown >
Returns void
+Defined in src/pools/abstract-pool.ts:1086
Private
update Task Stolen Statistics Worker Usage
@@ -1632,7 +1632,7 @@ Can be overridden.
taskName : string
Returns void
+Defined in src/pools/abstract-pool.ts:1426
Private
update Wait Time Worker Usage
@@ -1647,34 +1647,23 @@ Can be overridden.
task : Task < Data >
Returns void
-
+
+Protected
worker Message Listener
@@ -1747,6 +1736,8 @@ Can be overridden.
get Worker Info
get Worker Node Key By Worker
get Worker Node Key By Worker Id
+handle Back Pressure Event
+handle Empty Queue Event
handle Task Execution Response
handle Worker Ready Response
has Back Pressure
@@ -1779,9 +1770,7 @@ Can be overridden.
shall Execute Task
shall Update Task Function Worker Usage
start
-task Stealing On Empty Queue
tasks Queue Size
-tasks Stealing On Back Pressure
unset Task Stealing
unset Tasks Stealing On Back Pressure
update Elu Worker Usage
@@ -1789,9 +1778,9 @@ Can be overridden.
update Task Statistics Worker Usage
update Task Stolen Statistics Worker Usage
update Wait Time Worker Usage
-worker Listener
+worker Message Listener
-
\ No newline at end of file
+
\ No newline at end of file
Event 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:
@@ -224,7 +224,7 @@ The async tracking tooling identifier ispoolifier:<PoolType>-<Wo +Defined in src/pools/abstract-pool.ts:74
Path
file Path: string
@@ -232,7 +232,7 @@ The async tracking tooling identifier is
Protected
Readonly
filepoolifier:<PoolType>-<Wo