X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=9c8634f20a9bbcb03784f5938a8600901ef238d8;hb=33d02686234434468961547c907593eb19f2f526;hp=11212b2005cb21a76266044a1d3316fcba230c16;hpb=dbf662afd2c11c4d18c4e648f90d392528a715f8;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 11212b20..9c8634f2 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -
Optional
Readonly
emitterGenerated using TypeDoc
Emitter on which events can be listened to.
+
+Optional
emitterEvent 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.Protected
Readonly
fileProtected
Readonly
maxProtected
Readonly
numberProtected
Readonly
optsProtected
promiseProtected
workerReadonly
Internal
workerAccessors
Protected
full@@ -272,7 +274,7 @@ When the maximum number of workers is reached and workers are busy, an event is
info
@@ -284,7 +286,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Protected
max@@ -296,7 +298,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Protected
min@@ -308,7 +310,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Private
ready@@ -320,7 +322,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Protected
type@@ -333,7 +335,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Private
utilization@@ -346,7 +348,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Protected
worker@@ -358,7 +360,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Methods
Protected
after@@ -417,7 +419,7 @@ Can be overridden.
Protected
after@@ -438,7 +440,7 @@ Can be overridden.
Protected
before@@ -464,23 +466,7 @@ Can be overridden.
Dynamic Pool Size
-Protected
check-- check
Dynamic Pool Size(min, max): void
--
-
-
-
Parameters
---
-
--
-
min: number
max: number
Returns void
Protected
create@@ -493,7 +479,7 @@ Can be overridden.
Protected
create@@ -506,7 +492,7 @@ Can be overridden.
Protected
create@@ -519,7 +505,48 @@ Can be overridden.
Worker Message Listener
+Protected
deregister+- deregister
Worker Message Listener<Message>(workerNodeKey, listener): void
+-
+
+
+
+
+
+
Deregisters a listener callback on the worker given its worker node key.
+Type Parameters
++-
+
Message
Parameters
++-
+
+
+-
+
+
+
workerNodeKey: number
+The worker node key.
+listener: ((message) => void)
+The message listener callback.
++-
+
+- (message): void
+-
+
+
+
Parameters
++-
+
message: MessageValue<Message, unknown>
Returns void
Returns void
+destroy
@@ -531,7 +558,7 @@ Can be overridden.
Protected
destroy@@ -551,7 +578,7 @@ Can be overridden.
enable Tasks Queue
@@ -576,7 +603,7 @@ Can be overridden.
execute
@@ -607,7 +634,7 @@ Can be overridden.
Protected
flush@@ -621,7 +648,7 @@ Can be overridden.
Returns void
Protected
get@@ -642,7 +669,7 @@ Can be overridden.
has Task Function
@@ -663,7 +690,7 @@ Can be overridden.
has Worker Node Back Pressure
@@ -684,7 +711,7 @@ Can be overridden.
Protected
internal@@ -697,7 +724,7 @@ Can be overridden.
Protected
is@@ -709,7 +736,7 @@ Can be overridden.
list Task Function Names
@@ -722,7 +749,48 @@ Can be overridden.
Once Worker Message Listener
+Protected
register+- register
Once Worker Message Listener<Message>(workerNodeKey, listener): void
+-
+
+
+
+
+
+
Registers once a listener callback on the worker given its worker node key.
+Type Parameters
++-
+
Message
Parameters
++-
+
+
+-
+
+
+
workerNodeKey: number
+The worker node key.
+listener: ((message) => void)
+The message listener callback.
++-
+
+- (message): void
+-
+
+
+
Parameters
++-
+
message: MessageValue<Message, unknown>
Returns void
Returns void
+Protected
register@@ -763,7 +831,7 @@ Can be overridden.
remove Task Function
@@ -784,7 +852,7 @@ Can be overridden.
Protected
send@@ -798,7 +866,7 @@ Can be overridden.
Returns Promise<void>
Protected
send@@ -818,7 +886,7 @@ Can be overridden.
Protected
send@@ -843,7 +911,7 @@ Can be overridden.
set Default Task Function
@@ -864,7 +932,7 @@ Can be overridden.
set Tasks Queue Options
@@ -884,7 +952,7 @@ Can be overridden.
set Worker Choice Strategy
@@ -909,7 +977,7 @@ Can be overridden.
set Worker Choice Strategy Options
@@ -929,7 +997,7 @@ Can be overridden.
Protected
setup@@ -942,7 +1010,7 @@ Can be overridden.
start
@@ -954,35 +1022,24 @@ Can be overridden.
Listener
+Protected
workerProtected
worker-- worker
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
+- worker
Message Listener(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
Member Visibility
Theme
@@ -1024,10 +1081,10 @@ Can be overridden.after Task Execution Hook
after Worker Node Setup
before Task Execution Hook
-check Dynamic Pool Size
create And Setup Dynamic Worker Node
create And Setup Worker Node
create Worker
+deregister Worker Message Listener
destroy
destroy Worker Node
enable Tasks Queue
@@ -1039,6 +1096,7 @@ Can be overridden.
internal Busy
is Main
list Task Function Names
+register Once Worker Message Listener
register Worker Message Listener
remove Task Function
send Kill Message To Worker
@@ -1050,9 +1108,9 @@ Can be overridden.
set Worker Choice Strategy Options
setup Hook
start
-worker Listener