X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedThreadPool.html;h=47a026ff82721c1aa72076170ae95695fc76284d;hb=b2862722f44d3facf07a2e632d25d261f3dabbce;hp=5090dfb9163f584431ed3860a1a4e1edc5adb994;hpb=aab0aa502b6d1ca1e2b480460d9cf5f34707c34c;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 5090dfb9..47a026ff 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.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:
@@ -173,7 +173,7 @@ The async tracking tooling identifier ispoolifier:<PoolType>-<Wo +Defined in src/pools/abstract-pool.ts:74
Path
file Path: string
@@ -182,7 +182,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:129
max?: number
@@ -191,7 +191,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:79
Of Workers
number Of Workers: number
@@ -200,7 +200,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:128
opts: ThreadPoolOptions = {}
@@ -209,7 +209,7 @@ The async tracking tooling identifier is
+Defined in src/pools/thread/fixed.ts:49
Response Map
promise Response Map: Map<string, PromiseResponseWrapper<Response>> = ...
@@ -223,7 +223,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>
@@ -232,7 +232,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:94
Nodes
worker Nodes: IWorkerNode<Worker, Data>[] = []
@@ -241,7 +241,7 @@ The async tracking tooling identifier is
+Defined in src/pools/abstract-pool.ts:71
@@ -256,7 +256,7 @@ The async tracking tooling identifier is
+Defined in src/pools/thread/fixed.ts:154
+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/thread/fixed.ts:144
+Defined in src/pools/abstract-pool.ts:447
+Defined in src/pools/thread/fixed.ts:149
@@ -388,7 +388,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/thread/fixed.ts:136
Worker Message Listener
+Defined in src/pools/thread/fixed.ts:126
+Defined in src/pools/abstract-pool.ts:951
Worker Node
+Defined in src/pools/thread/fixed.ts:60
+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/thread/fixed.ts:55
+Defined in src/pools/abstract-pool.ts:846
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:830
Kill Message To Worker
+Defined in src/pools/abstract-pool.ts:962
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: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/abstract-pool.ts:998
-
-Defined in src/pools/abstract-pool.ts:935
+
+ Message Listener
Protected
Readonly
filepoolifier:<PoolType>-<Wo
Protected
Optional
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@@ -269,7 +269,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
info
@@ -281,7 +281,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Protected
max@@ -293,7 +293,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Protected
min@@ -305,7 +305,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Private
ready@@ -317,7 +317,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Protected
type@@ -330,7 +330,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Private
utilization@@ -343,7 +343,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Protected
worker@@ -355,7 +355,7 @@ The async tracking tooling identifier is
poolifier:<PoolType>-<Wo
Methods
Protected
after@@ -414,7 +414,7 @@ Can be overridden.
Protected
after@@ -435,7 +435,7 @@ Can be overridden.
Protected
before@@ -461,7 +461,7 @@ Can be overridden.
Protected
create@@ -474,7 +474,7 @@ Can be overridden.
Protected
create@@ -487,7 +487,7 @@ Can be overridden.
Protected
create@@ -500,7 +500,7 @@ Can be overridden.
Protected
deregister@@ -541,7 +541,7 @@ Can be overridden.
destroy
@@ -553,7 +553,7 @@ Can be overridden.
Protected
destroy@@ -573,7 +573,7 @@ Can be overridden.
enable Tasks Queue
@@ -598,7 +598,7 @@ Can be overridden.
execute
@@ -629,7 +629,7 @@ Can be overridden.
Protected
flush@@ -643,7 +643,7 @@ Can be overridden.
Returns void
Protected
get@@ -664,7 +664,7 @@ Can be overridden.
has Task Function
@@ -685,7 +685,7 @@ Can be overridden.
has Worker Node Back Pressure
@@ -706,7 +706,7 @@ Can be overridden.
Protected
internal@@ -719,7 +719,7 @@ Can be overridden.
Protected
is@@ -731,7 +731,7 @@ Can be overridden.
list Task Function Names
@@ -744,7 +744,7 @@ Can be overridden.
Protected
register@@ -785,7 +785,7 @@ Can be overridden.
Protected
register@@ -826,7 +826,7 @@ Can be overridden.
remove Task Function
@@ -847,7 +847,7 @@ Can be overridden.
Protected
send@@ -861,7 +861,7 @@ Can be overridden.
Returns Promise<void>
Protected
send@@ -881,7 +881,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