X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=9c8634f20a9bbcb03784f5938a8600901ef238d8;hb=b2862722f44d3facf07a2e632d25d261f3dabbce;hp=3c8b321fcf74e144f7d792f234d8c661977ec7ba;hpb=49fb18fe8d6e6a35ceabe2bce83b26073871e3b0;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 3c8b321f..9c8634f2 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -
Optional
emitterGenerated using TypeDoc
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:
@@ -178,7 +178,7 @@ The async tracking tooling identifier ispoolifier:<PoolType>-<Wo +Defined in src/pools/abstract-pool.ts:74
Path
file Path: string
@@ -187,7 +187,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:129
max: number
@@ -196,7 +196,7 @@ The async tracking tooling identifier is
+Defined in src/pools/cluster/dynamic.ts:30
Of Workers
number Of Workers: number
@@ -205,7 +205,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:128
opts: ClusterPoolOptions = {}
@@ -214,7 +214,7 @@ The async tracking tooling identifier is
+Defined in src/pools/cluster/fixed.ts:47
Response Map
promise Response Map: Map<string, PromiseResponseWrapper<Response>> = ...
@@ -228,7 +228,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:88
Choice Strategy Context
worker Choice Strategy Context: WorkerChoiceStrategyContext<Worker, Data, Response>
@@ -237,7 +237,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:94
Nodes
worker Nodes: IWorkerNode<Worker, Data>[] = []
@@ -246,7 +246,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:71
@@ -261,7 +261,7 @@ The async tracking tooling identifier is
+Defined in src/pools/cluster/dynamic.ts:44
+Defined in src/pools/abstract-pool.ts:662
+Defined in src/pools/abstract-pool.ts:272
Size
+Defined in src/pools/abstract-pool.ts:485
Size
+Defined in src/pools/abstract-pool.ts:478
+Defined in src/pools/abstract-pool.ts:430
+Defined in src/pools/cluster/dynamic.ts:39
+Defined in src/pools/abstract-pool.ts:447
+Defined in src/pools/cluster/fixed.ts:134
@@ -393,7 +393,7 @@ If a task function with the same name already exists, it will be overwritten.
+Defined in src/pools/abstract-pool.ts:807
Task Execution Hook
+Defined in src/pools/abstract-pool.ts:1044
Worker Node Setup
+Defined in src/pools/abstract-pool.ts:1355
Task Execution Hook
+Defined in src/pools/abstract-pool.ts:1014
And Setup Dynamic Worker Node
+Defined in src/pools/abstract-pool.ts:1261
And Setup Worker Node
+Defined in src/pools/abstract-pool.ts:1217
Worker
+Defined in src/pools/cluster/fixed.ts:124
Worker Message Listener
+Defined in src/pools/cluster/fixed.ts:116
+Defined in src/pools/abstract-pool.ts:951
Worker Node
+Defined in src/pools/cluster/fixed.ts:63
+Defined in src/pools/abstract-pool.ts:566
+Defined in src/pools/abstract-pool.ts:881
Tasks Queue
+Defined in src/pools/abstract-pool.ts:1687
Worker Info
+Defined in src/pools/abstract-pool.ts:1603
+Defined in src/pools/abstract-pool.ts:794
+Defined in src/pools/abstract-pool.ts:1645
Busy
+Defined in src/pools/abstract-pool.ts:678
Main
+Defined in src/pools/cluster/fixed.ts:58
+Defined in src/pools/abstract-pool.ts:846
Once Worker Message Listener
+Defined in src/pools/cluster/fixed.ts:108
Worker Message Listener
+Defined in src/pools/cluster/fixed.ts:100
+Defined in src/pools/abstract-pool.ts:830
Kill Message To Worker
+Defined in src/pools/abstract-pool.ts:962
Startup Message To Worker
+Defined in src/pools/cluster/fixed.ts:93
To Worker
+Defined in src/pools/cluster/fixed.ts:82
+Defined in src/pools/abstract-pool.ts:859
+Defined in src/pools/abstract-pool.ts:580
+Defined in src/pools/abstract-pool.ts:533
+Defined in src/pools/abstract-pool.ts:552
Hook
+Defined in src/pools/cluster/fixed.ts:53
-
-Defined in src/pools/abstract-pool.ts:935
+
+ Message Listener
Protected
Readonly
filepoolifier:<PoolType>-<Wo
Protected
Readonly
maxpoolifier:<PoolType>-<Wo
Protected
Readonly
numberpoolifier:<PoolType>-<Wo
Protected
Readonly
optspoolifier:<PoolType>-<Wo
Protected
promisepoolifier:<PoolType>-<Wo
Protected
workerpoolifier:<PoolType>-<Wo
Readonly
Internal
workerpoolifier:<PoolType>-<Wo
Accessors
poolifier:<PoolType>-<Wo
Protected
full@@ -274,7 +274,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
info
@@ -286,7 +286,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Protected
max@@ -298,7 +298,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Protected
min@@ -310,7 +310,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Private
ready@@ -322,7 +322,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Protected
type@@ -335,7 +335,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Private
utilization@@ -348,7 +348,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Protected
worker@@ -360,7 +360,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Methods
Protected
after@@ -419,7 +419,7 @@ Can be overridden.
Protected
after@@ -440,7 +440,7 @@ Can be overridden.
Protected
before@@ -466,7 +466,7 @@ Can be overridden.
Protected
create@@ -479,7 +479,7 @@ Can be overridden.
Protected
create@@ -492,7 +492,7 @@ Can be overridden.
Protected
create@@ -505,7 +505,7 @@ Can be overridden.
Protected
deregister@@ -546,7 +546,7 @@ Can be overridden.
destroy
@@ -558,7 +558,7 @@ Can be overridden.
Protected
destroy@@ -578,7 +578,7 @@ Can be overridden.
enable Tasks Queue
@@ -603,7 +603,7 @@ Can be overridden.
execute
@@ -634,7 +634,7 @@ Can be overridden.
Protected
flush@@ -648,7 +648,7 @@ Can be overridden.
Returns void
Protected
get@@ -669,7 +669,7 @@ Can be overridden.
has Task Function
@@ -690,7 +690,7 @@ Can be overridden.
has Worker Node Back Pressure
@@ -711,7 +711,7 @@ Can be overridden.
Protected
internal@@ -724,7 +724,7 @@ Can be overridden.
Protected
is@@ -736,7 +736,7 @@ Can be overridden.
list Task Function Names
@@ -749,7 +749,7 @@ Can be overridden.
Protected
register@@ -790,7 +790,7 @@ Can be overridden.
Protected
register@@ -831,7 +831,7 @@ Can be overridden.
remove Task Function
@@ -852,7 +852,7 @@ Can be overridden.
Protected
send@@ -866,7 +866,7 @@ Can be overridden.
Returns Promise<void>
Protected
send@@ -886,7 +886,7 @@ Can be overridden.
Protected
send@@ -911,7 +911,7 @@ Can be overridden.
set Default Task Function
@@ -932,7 +932,7 @@ Can be overridden.
set Tasks Queue Options
@@ -952,7 +952,7 @@ Can be overridden.
set Worker Choice Strategy
@@ -977,7 +977,7 @@ Can be overridden.
set Worker Choice Strategy Options
@@ -997,7 +997,7 @@ Can be overridden.
Protected
setup@@ -1010,7 +1010,7 @@ Can be overridden.
start
@@ -1022,35 +1022,24 @@ Can be overridden.
Listener
+Protected
workerProtected
worker-- worker
Listener(): ((message) => void)
+- worker
Message Listener(message): void
-
-
-
This method is the listener registered for each worker message.
-Returns ((message) => void)
The listener function to execute when a message is received from a worker.
- ---
-
-- (message): void
--
-
-
-
+ - Defined in src/pools/abstract-pool.ts:1517
This method is the listener registered for each worker message.
+This method is the message listener registered on each worker.
Parameters
message: MessageValue<Response, unknown>
Returns void
The listener function to execute when a message is received from a worker.
- - +Returns void