X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=dff66fdd08f442f39ad5e998942b04b4375a0253;hb=d2c0b687e4d618db173a9176eeabdd0ff0dff4ee;hp=2e5dd84e56c7176ef78dad947d0802d54bb1dd6b;hpb=a13e50c30dd0e0714ace0e1ea4ea1b36cdd18ab7;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 2e5dd84e..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
file
+Protected
Optional
Readonly
maxDynamic pool maximum size property placeholder.
+Protected
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
worker Nodes
+Readonly
workerReadonly
Internal
workerPool worker nodes.
Accessors
Protected
full@@ -250,7 +269,7 @@
info
@@ -262,31 +281,31 @@
Size
-Protected
max+- get maxSize(): number
-
The pool maximum size.
Returns number
Size
-Protected
min+- get minSize(): number
-
The pool minimum size.
Returns number
Private
ready@@ -298,7 +317,7 @@
Protected
type@@ -311,7 +330,7 @@
Private
utilization@@ -324,7 +343,7 @@
Protected
worker@@ -336,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@@ -364,7 +414,7 @@ Can be overridden.
Protected
after@@ -385,7 +435,7 @@ Can be overridden.
Protected
before@@ -411,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@@ -440,7 +474,7 @@ Can be overridden.
Protected
create@@ -453,7 +487,7 @@ Can be overridden.
Protected
create@@ -466,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
@@ -478,7 +553,7 @@ Can be overridden.
Protected
destroy@@ -498,32 +573,32 @@ Can be overridden.
enable Tasks Queue
Enables/disables the worker tasks queue in this pool.
+Enables/disables the worker node tasks queue in this pool.
Parameters
enable: boolean
-Whether to enable or disable the worker tasks queue.
+Whether to enable or disable the worker node tasks queue.
-Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+The worker node tasks queue options.
Returns void
execute
@@ -554,7 +629,7 @@ Can be overridden.
Protected
flush@@ -568,7 +643,7 @@ Can be overridden.
Returns void
Protected
get@@ -589,7 +664,49 @@ Can be overridden.
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
++- has
Worker Node Back Pressure(workerNodeKey): boolean
+
+
+
+
Internal
+Whether the worker node has back pressure (i.e. its tasks queue is full).
+Parameters
++-
+
+
workerNodeKey: number
+The worker node key.
+Returns boolean
+ +true
if the worker node has back pressure,false
otherwise.Protected
internal@@ -602,7 +719,7 @@ Can be overridden.
Protected
is@@ -614,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@@ -668,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@@ -704,7 +881,7 @@ Can be overridden.
Protected
send@@ -729,27 +906,48 @@ 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
Sets the worker tasks queue options in this pool.
+Sets the worker node tasks queue options in this pool.
Parameters
tasksQueueOptions: TasksQueueOptions
-The worker tasks queue options.
+The worker node tasks queue options.
Returns void
set Worker Choice Strategy
@@ -774,7 +972,7 @@ Can be overridden.
set Worker Choice Strategy Options
@@ -794,7 +992,7 @@ Can be overridden.
Protected
setup@@ -807,7 +1005,19 @@ Can be overridden.
start
++- start(): void
+-
+
+
Starts the minimum number of workers in this pool.
+Returns void
+Protected
worker@@ -835,20 +1045,20 @@ Can be overridden.
-
+Settings
Settings
Member Visibility
Theme
@@ -858,6 +1068,7 @@ Can be overridden.- constructor
- emitter
- file
Path
+- max
- number
Of Workers
- opts
- promise
Response Map
@@ -866,100 +1077,69 @@ Can be overridden.
- busy
- full
- info
-- max
Size
-- min
Size
+- max
Size
+- min
Size
- ready
- type
- utilization
- worker
+- add
Task Function
- 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
- execute
- flush
Tasks Queue
- get
Worker Info
+- has
Task Function
+- has
Worker Node Back Pressure
- internal
Busy
- is
Main
-- list
Task Functions
+- list
Task Function Names
+- register
Once Worker Message Listener
- register
Worker Message Listener
+- remove
Task Function
- send
Kill Message To Worker
- send
Startup Message To Worker
- send
To Worker
+- set
Default Task Function
- set
Tasks Queue Options
- set
Worker Choice Strategy
- set
Worker Choice Strategy Options
- setup
Hook
+- start
- worker
Listener