X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FDynamicThreadPool.html;h=66d9f45a8f6237d9b94258e27bce62d4bc7e8bd9;hb=6c4fa3e1bd11a23fd83b8492ad941a323853de06;hp=e9f33e6bacfeac5a43afe2d134ce5ad9a3b9fc83;hpb=49fb18fe8d6e6a35ceabe2bce83b26073871e3b0;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index e9f33e6b..66d9f45a 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.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:73
Path
file Path: string
@@ -187,7 +187,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:128
max: number
@@ -196,7 +196,7 @@ The async tracking tooling identifier is
+Defined in src/pools/thread/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:127
opts: ThreadPoolOptions = {}
@@ -214,7 +214,7 @@ The async tracking tooling identifier is
+Defined in src/pools/thread/fixed.ts:49
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:87
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:93
Nodes
worker Nodes: IWorkerNode<Worker, Data>[] = []
@@ -246,7 +246,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:70
@@ -261,7 +261,7 @@ The async tracking tooling identifier is
+Defined in src/pools/thread/dynamic.ts:44
+Defined in src/pools/abstract-pool.ts:651
+Defined in src/pools/abstract-pool.ts:271
Size
+Defined in src/pools/abstract-pool.ts:484
Size
+Defined in src/pools/abstract-pool.ts:477
+Defined in src/pools/abstract-pool.ts:429
+Defined in src/pools/thread/dynamic.ts:39
+Defined in src/pools/abstract-pool.ts:446
+Defined in src/pools/thread/fixed.ts:149
@@ -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:796
Task Execution Hook
+Defined in src/pools/abstract-pool.ts:1033
Worker Node Setup
+Defined in src/pools/abstract-pool.ts:1344
Task Execution Hook
+Defined in src/pools/abstract-pool.ts:1003
And Setup Dynamic Worker Node
+Defined in src/pools/abstract-pool.ts:1250
And Setup Worker Node
+Defined in src/pools/abstract-pool.ts:1206
Worker
+Defined in src/pools/thread/fixed.ts:136
Worker Message Listener
+Defined in src/pools/thread/fixed.ts:126
+Defined in src/pools/abstract-pool.ts:940
Worker Node
+Defined in src/pools/thread/fixed.ts:60
+Defined in src/pools/abstract-pool.ts:565
+Defined in src/pools/abstract-pool.ts:870
Tasks Queue
+Defined in src/pools/abstract-pool.ts:1666
Worker Info
+Defined in src/pools/abstract-pool.ts:1582
+Defined in src/pools/abstract-pool.ts:783
+Defined in src/pools/abstract-pool.ts:1624
Busy
+Defined in src/pools/abstract-pool.ts:667
Main
+Defined in src/pools/thread/fixed.ts:55
+Defined in src/pools/abstract-pool.ts:835
Once Worker Message Listener
+Defined in src/pools/thread/fixed.ts:116
Worker Message Listener
+Defined in src/pools/thread/fixed.ts:106
+Defined in src/pools/abstract-pool.ts:819
Kill Message To Worker
+Defined in src/pools/abstract-pool.ts:951
Startup Message To Worker
+Defined in src/pools/thread/fixed.ts:91
To Worker
+Defined in src/pools/thread/fixed.ts:77
+Defined in src/pools/abstract-pool.ts:848
+Defined in src/pools/abstract-pool.ts:579
+Defined in src/pools/abstract-pool.ts:532
+Defined in src/pools/abstract-pool.ts:551
Hook
+Defined in src/pools/abstract-pool.ts:987
-
-Defined in src/pools/abstract-pool.ts:924
+
+ 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@@ -916,7 +916,7 @@ Can be overridden.
set Default Task Function
@@ -937,7 +937,7 @@ Can be overridden.
set Tasks Queue Options
@@ -957,7 +957,7 @@ Can be overridden.
set Worker Choice Strategy
@@ -982,7 +982,7 @@ Can be overridden.
set Worker Choice Strategy Options
@@ -1002,7 +1002,7 @@ Can be overridden.
Protected
setup@@ -1015,7 +1015,7 @@ Can be overridden.
start
@@ -1027,35 +1027,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:1496
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