X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedThreadPool.html;h=6179daf6735a2a7ef010e26a3b3eae7b3811e41c;hb=29527e83440c324c4a78154ceba4c1076908f5d7;hp=f2be816aa26c6b07d2bd10a30f95af68045c57b6;hpb=c4d8442aed5e5a9d6cde9f3bfd721be3033c1eef;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index f2be816a..6179daf6 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -
Protected
Readonly
fileProtected
Optional
Readonly
maxProtected
Readonly
numberProtected
Readonly
optsProtected
promise
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@@ -262,7 +268,7 @@
info
@@ -274,7 +280,7 @@
Protected
max@@ -286,7 +292,7 @@
Protected
min@@ -298,7 +304,7 @@
Private
ready@@ -310,7 +316,7 @@
Protected
type@@ -323,7 +329,7 @@
Private
utilization@@ -336,7 +342,7 @@
Protected
worker@@ -348,9 +354,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 +413,7 @@ Can be overridden.
Protected
after@@ -397,7 +434,7 @@ Can be overridden.
Protected
before@@ -423,23 +460,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 +473,7 @@ Can be overridden.
Protected
create@@ -465,7 +486,7 @@ Can be overridden.
Protected
create@@ -478,7 +499,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 +552,7 @@ Can be overridden.
Protected
destroy@@ -510,7 +572,7 @@ Can be overridden.
enable Tasks Queue
@@ -535,7 +597,7 @@ Can be overridden.
execute
@@ -566,7 +628,7 @@ Can be overridden.
Protected
flush@@ -580,7 +642,7 @@ Can be overridden.
Returns void
Protected
get@@ -601,7 +663,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
@@ -622,7 +705,7 @@ Can be overridden.
Protected
internal@@ -635,7 +718,7 @@ Can be overridden.
Protected
is@@ -647,20 +730,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 +825,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 +880,7 @@ Can be overridden.
Protected
send@@ -767,7 +910,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
@@ -787,7 +951,7 @@ Can be overridden.
set Worker Choice Strategy
@@ -812,7 +976,7 @@ Can be overridden.
set Worker Choice Strategy Options
@@ -832,7 +996,7 @@ Can be overridden.
Protected
setup@@ -845,7 +1009,19 @@ Can be overridden.
start
++- start(): void
+-
+
+
Starts the minimum number of workers in this pool.
+Returns void
+Protected
worker@@ -873,7 +1049,7 @@ Can be overridden.