X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=ae97fc9c47f17ba9f1c4a5f03a3d8e2956420eaf;hb=b2ec8632edaea1f4ee24a532e61ca6e5619b7bfb;hp=2fdd9ea72c55012e5cb3a70b655e70cb2d876dea;hpb=c11be5eddc7229e4b77105ed27e93697b65d0146;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 2fdd9ea7..ae97fc9c 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@@ -273,7 +275,7 @@ When the maximum number of workers is reached and workers are busy, an event is
info
@@ -285,7 +287,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Protected
max@@ -297,7 +299,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Protected
min@@ -309,7 +311,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Private
ready@@ -321,7 +323,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Protected
type@@ -334,7 +336,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Private
utilization@@ -347,7 +349,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Protected
worker@@ -359,7 +361,7 @@ When the maximum number of workers is reached and workers are busy, an event is
Methods
Protected
after@@ -418,7 +420,7 @@ Can be overridden.
Protected
after@@ -439,7 +441,7 @@ Can be overridden.
Protected
before@@ -465,7 +467,7 @@ Can be overridden.
Protected
create@@ -478,7 +480,7 @@ Can be overridden.
Protected
create@@ -491,7 +493,7 @@ Can be overridden.
Protected
create@@ -504,7 +506,7 @@ Can be overridden.
Protected
deregister@@ -545,7 +547,7 @@ Can be overridden.
destroy
@@ -557,7 +559,7 @@ Can be overridden.
Protected
destroy@@ -577,7 +579,7 @@ Can be overridden.
enable Tasks Queue
@@ -602,7 +604,7 @@ Can be overridden.
execute
@@ -633,7 +635,21 @@ Can be overridden.
Worker Node As Not Ready
+Protected
flag+- flag
Worker Node As Not Ready(workerNodeKey): void
+-
+
+
+
Parameters
++-
+
workerNodeKey: number
Returns void
Protected
flush@@ -647,7 +663,7 @@ Can be overridden.
Returns void
Protected
get@@ -668,7 +684,7 @@ Can be overridden.
has Task Function
@@ -689,7 +705,7 @@ Can be overridden.
has Worker Node Back Pressure
@@ -710,7 +726,7 @@ Can be overridden.
Protected
internal@@ -723,7 +739,7 @@ Can be overridden.
Protected
is@@ -735,7 +751,7 @@ Can be overridden.
list Task Function Names
@@ -748,7 +764,7 @@ Can be overridden.
Protected
register@@ -789,7 +805,7 @@ Can be overridden.
Protected
register@@ -830,7 +846,7 @@ Can be overridden.
remove Task Function
@@ -851,7 +867,7 @@ Can be overridden.
Protected
send@@ -865,7 +881,7 @@ Can be overridden.
Returns Promise<void>
Protected
send@@ -885,7 +901,7 @@ Can be overridden.
Protected
send@@ -910,7 +926,7 @@ Can be overridden.
set Default Task Function
@@ -931,7 +947,7 @@ Can be overridden.
set Tasks Queue Options
@@ -951,7 +967,7 @@ Can be overridden.
set Worker Choice Strategy
@@ -976,7 +992,7 @@ Can be overridden.
set Worker Choice Strategy Options
@@ -996,7 +1012,7 @@ Can be overridden.
Protected
setup@@ -1009,7 +1025,7 @@ Can be overridden.
start
@@ -1021,35 +1037,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:1518
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
@@ -1099,6 +1104,7 @@ Can be overridden.destroy Worker Node
enable Tasks Queue
execute
+flag Worker Node As Not Ready
flush Tasks Queue
get Worker Info
has Task Function
@@ -1118,9 +1124,9 @@ Can be overridden.
set Worker Choice Strategy Options
setup Hook
start
-worker Listener