X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=2166bd9e8f654b27931d5690dd560f785247e2b5;hb=d2c0b687e4d618db173a9176eeabdd0ff0dff4ee;hp=d67f2ee59741e24be60bc7cc1bbec6a9cf3586b3;hpb=cb4889b43e6935f6dd70d8011ba085c9ca7218ba;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index d67f2ee5..2166bd9e 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.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
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@@ -267,7 +274,7 @@ When the maximum number of threads is reached and workers are busy, an event is
info
@@ -279,7 +286,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Protected
max@@ -291,7 +298,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Protected
min@@ -303,7 +310,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Private
ready@@ -315,7 +322,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Protected
type@@ -328,7 +335,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Private
utilization@@ -341,7 +348,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Protected
worker@@ -353,9 +360,40 @@ When the maximum number of threads is reached and workers are busy, an event is
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@@ -381,7 +419,7 @@ Can be overridden.
Protected
after@@ -402,7 +440,7 @@ Can be overridden.
Protected
before@@ -428,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@@ -457,7 +479,7 @@ Can be overridden.
Protected
create@@ -470,7 +492,7 @@ Can be overridden.
Protected
create@@ -483,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
@@ -495,7 +558,7 @@ Can be overridden.
Protected
destroy@@ -515,7 +578,7 @@ Can be overridden.
enable Tasks Queue
@@ -540,7 +603,7 @@ Can be overridden.
execute
@@ -571,7 +634,7 @@ Can be overridden.
Protected
flush@@ -585,7 +648,7 @@ Can be overridden.
Returns void
Protected
get@@ -606,7 +669,28 @@ 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
@@ -627,7 +711,7 @@ Can be overridden.
Protected
internal@@ -640,7 +724,7 @@ Can be overridden.
Protected
is@@ -652,20 +736,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@@ -706,23 +831,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@@ -742,7 +886,7 @@ Can be overridden.
Protected
send@@ -772,7 +916,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
@@ -792,7 +957,7 @@ Can be overridden.
set Worker Choice Strategy
@@ -817,7 +982,7 @@ Can be overridden.
set Worker Choice Strategy Options
@@ -837,7 +1002,7 @@ Can be overridden.
Protected
setup@@ -850,7 +1015,19 @@ Can be overridden.
start
++- start(): void
+-
+
+
Starts the minimum number of workers in this pool.
+Returns void
+Protected
worker@@ -878,7 +1055,7 @@ Can be overridden.