X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=dff66fdd08f442f39ad5e998942b04b4375a0253;hb=d2c0b687e4d618db173a9176eeabdd0ff0dff4ee;hp=03d19a9dd2acdc222457bf34298b95ed01996a6b;hpb=0fa1d6f0433baf6ff3f67fefdbdf610612a4f3e9;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 03d19a9d..dff66fdd 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,13 +1,13 @@ -
Optional
Readonly
emitterGenerated using TypeDoc
Generated 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.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.'busy'
: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.'full'
: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.destroy
': Emitted when the pool is destroyed.'destroy'
: Emitted when the pool is destroyed.'error'
: Emitted when an uncaught error occurs.'taskError'
: Emitted when an error occurs while executing a task.'backPressure'
: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).Protected
Readonly
fileProtected
Optional
Readonly
maxProtected
Readonly
numberProtected
Readonly
optsProtected
promiseThe task execution response promise map.
+The task execution response promise map:
key
: The message id of each submitted task.value
: An object that contains the worker, the execution response promise resolve and reject callbacks.Protected
workerReadonly
Internal
workerAccessors
Protected
full@@ -262,7 +269,7 @@
info
@@ -274,7 +281,7 @@
Protected
max@@ -286,7 +293,7 @@
Protected
min@@ -298,7 +305,7 @@
Private
ready@@ -310,7 +317,7 @@
Protected
type@@ -323,7 +330,7 @@
Private
utilization@@ -336,7 +343,7 @@
Protected
worker@@ -348,9 +355,40 @@
Methods
+add Task Function
++- add
Task Function(name, fn): Promise<boolean>
+-
+
+
+
+
+
Adds a task function to this pool. +If a task function with the same name already exists, it will be overwritten.
+Parameters
++-
+
+
+-
+
+
name: string
+The name of the task function.
+fn: TaskFunction<Data, Response>
+The task function.
+Returns Promise<boolean>
+ +true
if the task function was added,false
otherwise.Throws
https://nodejs.org/api/errors.html#class-typeerror If the
+ +name
parameter is not a string or an empty string.Throws
https://nodejs.org/api/errors.html#class-typeerror If the
+fn
parameter is not a function.Protected
after@@ -376,7 +414,7 @@ Can be overridden.
Protected
after@@ -397,7 +435,7 @@ Can be overridden.
Protected
before@@ -423,23 +461,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@@ -452,7 +474,7 @@ Can be overridden.
Protected
create@@ -465,7 +487,7 @@ Can be overridden.
Protected
create@@ -478,7 +500,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
@@ -490,7 +553,7 @@ Can be overridden.
Protected
destroy@@ -510,7 +573,7 @@ Can be overridden.
enable Tasks Queue
@@ -535,7 +598,7 @@ Can be overridden.
execute
@@ -566,7 +629,7 @@ Can be overridden.
Protected
flush@@ -580,11 +643,11 @@ Can be overridden.
Returns void
Protected
get-- get
Worker Info(workerNodeKey): undefined | WorkerInfo
+- get
Worker Info(workerNodeKey): WorkerInfo
-
@@ -596,12 +659,33 @@ Can be overridden.
Gets the worker information given its worker node key.
The worker node key.
Returns undefined | WorkerInfo
The worker information.
+Returns WorkerInfo
The worker information.
+has Task Function
++- has
Task Function(name): boolean
+-
+
+
+
+
Whether the specified task function exists in this pool.
+Parameters
++-
+
+
name: string
+The name of the task function.
+Returns boolean
+ +true
if the task function exists,false
otherwise.has Worker Node Back Pressure
@@ -622,7 +706,7 @@ Can be overridden.
Protected
internal@@ -635,7 +719,7 @@ Can be overridden.
Protected
is@@ -647,20 +731,61 @@ Can be overridden.
list Task Functions
+list Task Function Names
-- list
Task Functions(): string[]
+- list
Task Function Names(): string[]
-
Lists the names of task function available in this pool.
Returns string[]
The names of task function available in this pool.
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@@ -701,23 +826,42 @@ Can be overridden.
remove Task Function
++- remove
Task Function(name): Promise<boolean>
+-
+
+
+
+
Removes a task function from this pool.
+Parameters
++-
+
+
name: string
+The name of the task function.
+Returns Promise<boolean>
+ +true
if the task function was removed,false
otherwise.Protected
send-- send
Kill Message To Worker(workerNodeKey, workerId): Promise<void>
+- send
Kill Message To Worker(workerNodeKey): Promise<void>
-
-
-
--
-
+
Parameters
workerNodeKey: number
workerId: number
workerNodeKey: number
Returns Promise<void>
Protected
send@@ -737,7 +881,7 @@ Can be overridden.
Protected
send@@ -762,7 +906,28 @@ Can be overridden.
set Default Task Function
++- set
Default Task Function(name): Promise<boolean>
+-
+
+
+
+
Sets the default task function in this pool.
+Parameters
++-
+
+
name: string
+The name of the task function.
+Returns Promise<boolean>
+ +true
if the default task function was set,false
otherwise.set Tasks Queue Options
@@ -782,7 +947,7 @@ Can be overridden.
set Worker Choice Strategy
@@ -807,7 +972,7 @@ Can be overridden.
set Worker Choice Strategy Options
@@ -827,7 +992,7 @@ Can be overridden.
Protected
setup@@ -840,7 +1005,19 @@ Can be overridden.
start
++- start(): void
+-
+
+
Starts the minimum number of workers in this pool.
+Returns void
+Protected
worker@@ -868,20 +1045,20 @@ Can be overridden.