X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicThreadPool.html;h=c03d97602875426e0db043c5929bac798b9e384e;hb=c11be5eddc7229e4b77105ed27e93697b65d0146;hp=ee4623ac797aa44ba2cd3cfee8df86c8c8091ebb;hpb=603ce450e1c02a53a06aff9e9ba5f3cdee24a3f2;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index ee4623ac..c03d9760 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,13 +1,13 @@ -
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
Readonly
maxProtected
Readonly
numberProtected
Readonly
optsProtected
promiseProtected
sendProtected
sendProtected
setupProtected
workerGenerated using TypeDoc
Generated using TypeDoc
+ \ No newline at end of file
The 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 +273,7 @@ When the maximum number of threads is reached and workers are busy, an event is
info
@@ -279,7 +285,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Protected
max@@ -291,7 +297,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Protected
min@@ -303,7 +309,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Private
ready@@ -315,7 +321,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Protected
type@@ -328,7 +334,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Private
utilization@@ -341,7 +347,7 @@ When the maximum number of threads is reached and workers are busy, an event is
Protected
worker@@ -353,9 +359,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 +418,7 @@ Can be overridden.
Protected
after@@ -402,7 +439,7 @@ Can be overridden.
Protected
before@@ -428,23 +465,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 +478,7 @@ Can be overridden.
Protected
create@@ -470,7 +491,7 @@ Can be overridden.
Protected
create@@ -483,7 +504,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 +557,7 @@ Can be overridden.
Protected
destroy@@ -515,7 +577,7 @@ Can be overridden.
enable Tasks Queue
@@ -540,7 +602,7 @@ Can be overridden.
execute
@@ -571,7 +633,7 @@ Can be overridden.
Protected
flush@@ -585,11 +647,11 @@ Can be overridden.
Returns void
Protected
get-- get
Worker Info(workerNodeKey): undefined | WorkerInfo
+- get
Worker Info(workerNodeKey): WorkerInfo
-
@@ -601,12 +663,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
@@ -627,7 +710,7 @@ Can be overridden.
Protected
internal@@ -640,7 +723,7 @@ Can be overridden.
Protected
is@@ -652,20 +735,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 +830,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