X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FClusterWorker.html;h=3a9a473cacbd623a973466bed1203856fccde754;hb=ef9f489c870680b9a754ab8e5b142b3f042a9ebb;hp=e2f4c93020dc4de1192cbc2046d3d52d742a2e94;hpb=5e5a659e2b415c7d533dad095eda082989983f8e;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index e2f4c930..3a9a473c 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -
Removes a task function from the worker.
+The name of the task function to remove.
+Whether the task function existed and was removed or not.
+ +https://nodejs.org/api/errors.html#class-typeerror If the name
parameter is not a string.
https://nodejs.org/api/errors.html#class-error If the name
parameter is the default task function reserved name.
https://nodejs.org/api/errors.html#class-error If the name
parameter is the task function used as default task function.
Protected
runRuns the given task.
+The task to execute.
+https://nodejs.org/api/errors.html#class-error If the task function is not found.
+Protected
runRuns the given function asynchronously.
Function that will be executed.
+Task function that will be executed.
Protected
runRuns the given function synchronously.
Function that will be executed.
+Task function that will be executed.
Protected
sendThe response message.
Sets the default task function to use when no task function name is specified.
+The name of the task function to use as default task function.
+Whether the default task function was set or not.
+ +https://nodejs.org/api/errors.html#class-typeerror If the name
parameter is not a string.
https://nodejs.org/api/errors.html#class-error If the name
parameter is the default task function reserved name.
https://nodejs.org/api/errors.html#class-error If the name
parameter is a non-existing task function.
Protected
workerStatic
bindGenerated using TypeDoc
Type of data this worker receives from pool's execution. This can only be serializable data.
+Type of data this worker receives from pool's execution. This can only be structured-cloneable data.
Response = unknown
-Type of response the worker sends back to the main worker. This can only be serializable data.
+Type of response the worker sends back to the main worker. This can only be structured-cloneable data.
@@ -68,19 +68,28 @@ but the minimum number of workers will be guaranteed. task Functions
Accessors
+Methods
-Properties
Interval
+Protected
Optional
Readonly
aliveProtected
Optional
aliveHandler id of the
aliveInterval
worker alive check.Protected
Readonly
isProtected
last Worker
-Protected
main Worker
+Protected
Readonly
mainReference to main worker.
Protected
Readonly
optsProtected
statisticsPerformance statistics computation.
+Performance statistics computation requirements.
Protected
taskAccessors
+
+Protected
id+- get id(): number
+-
+
+
Worker id.
+Returns number
+Methods
+add Task Function
++- add
Task Function(name, fn): boolean
+-
+
+
+
+
+
Adds a task function to the worker. +If a task function with the same name already exists, it is replaced.
+Parameters
++-
+
+
+-
+
+
name: string
+The name of the task function to add.
+fn: WorkerFunction<Data, Response>
+The task function to add.
+Returns boolean
Whether the task function was added or not.
+ +Throws
https://nodejs.org/api/errors.html#class-typeerror If the
+ +name
parameter is not a string.Throws
https://nodejs.org/api/errors.html#class-error If the
+ +name
parameter is the default task function reserved name.Throws
https://nodejs.org/api/errors.html#class-typeerror If the
+fn
parameter is not a function.async Id
@@ -194,7 +250,7 @@ but the minimum number of workers will be guaranteed.
bind
@@ -221,19 +277,7 @@ but the minimum number of workers will be guaranteed.
Alive
-Protected
check-- check
Alive(): void
--
-
-
Checks if the worker should be terminated, because its living too long.
-Returns void
-emit Destroy
@@ -249,7 +293,7 @@ never be called.
Protected
get@@ -262,10 +306,10 @@ never be called.
Error
-Protected
handle+- handle
Error(e): string
-
-
Handles an error and convert it to a string so it can be sent back to the main worker.
@@ -278,12 +322,35 @@ never be called.The error raised by the worker.
Returns string
Message of the error.
+Returns string
The error message.
has Task Function
++- has
Task Function(name): boolean
+-
+
+
+
+
+
Checks if the worker has a task function with the given name.
+Parameters
++-
+
+
name: string
+The name of the task function to check.
+Returns boolean
Whether the worker has a task function with the given name or not.
+ +Throws
https://nodejs.org/api/errors.html#class-typeerror If the
+name
parameter is not a string.Protected
message@@ -295,7 +362,7 @@ never be called.-
-
Parameters
message: MessageValue<Data, Data, Worker>
+message: MessageValue<Data, Data>
Message received.