X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FClusterWorker.html;h=3e6c19db8886b711389ed021b77d43ae616be086;hb=1b64ffbd6aa476a11839e461c2adac0c5bd34ed1;hp=60a63dc43dc3b639890204c10cdca7cbefe8d4ac;hpb=86de0a2d983a71579980758f52cf4c7f1c16abf8;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 60a63dc4..3e6c19db 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -
Generated using TypeDoc
A cluster worker used by a poolifier
+ClusterPool
.- Preparing search index...
- The search index is not available
poolifier - v4.0.2Class ClusterWorker<Data, Response>
A cluster worker used by a poolifier
ClusterPool
.When this worker is inactive for more than the given
maxInactiveTime
, it will send a termination request to its main worker.If you use a
DynamicClusterPool
the extra workers that were created will be terminated, @@ -7,7 +7,7 @@ but the minimum number of workers will be guaranteed.Since
2.0.0
Type Parameters
Type of data this worker receives from pool's execution. This can only be structured-cloneable data.
Type of response the worker sends back to the main worker. This can only be structured-cloneable data.
-Hierarchy (view full)
Index
Constructors
Hierarchy (view full)
Index
Constructors
Properties
Constructors
constructor
Constructs a new poolifier cluster worker.
Type Parameters
Parameters
Task function(s) processed by the worker when the pool's
execution
function is invoked.Options for the worker.
-Returns ClusterWorker<Data, Response>
Properties
Protected
Optional
activeHandler id of the
-activeInterval
worker activity check.Protected
Readonly
isWhether this is the main worker or not.
-Protected
lastTimestamp of the last task processed by this worker.
-Protected
optsOptions for the worker.
-Protected
Optional
statisticsPerformance statistics computation requirements.
-Protected
taskTask function(s) processed by the worker when the pool's
-execution
function is invoked.Accessors
Protected
idWorker id.
-Returns number
Methods
add Task Function
Adds a task function to the worker. +
Returns ClusterWorker<Data, Response>
Properties
Protected
Optional
activeHandler id of the
+activeInterval
worker activity check.Protected
Readonly
isWhether this is the main worker or not.
+Protected
lastTimestamp of the last task processed by this worker.
+Protected
optsOptions for the worker.
+Protected
Optional
statisticsPerformance statistics computation requirements.
+Protected
taskTask function object(s) processed by the worker when the pool's
+execution
function is invoked.Accessors
Protected
idWorker id.
+Returns number
Methods
add Task Function
Adds a task function to the worker. If a task function with the same name already exists, it is replaced.
Parameters
The name of the task function to add.
-The task function to add.
+The task function to add.
Returns TaskFunctionOperationResult
Whether the task function was added or not.
-Protected
getReturns the main worker.
+Protected
getReturns the main worker.
Returns Worker
Reference to the main worker.
Throws
https://nodejs.org/api/errors.html#class-error If the main worker is not set.
-Protected
handleHandles an error and convert it to a string so it can be sent back to the main worker.
+Protected
handleHandles an error and convert it to a string so it can be sent back to the main worker.
Parameters
The error raised by the worker.
Returns string
The error message.
-Protected
handleHandles a kill message sent by the main worker.
-Parameters
Returns void
Protected
handleHandles the ready message sent by the main worker.
+Protected
handleHandles a kill message sent by the main worker.
+Parameters
Returns void
Protected
handleHandles the ready message sent by the main worker.
Parameters
The ready message.
-Returns void
Protected
handleParameters
Returns void
has Task Function
Checks if the worker has a task function with the given name.
+Returns void
Protected
handleParameters
Returns void
has Task Function
Checks if the worker has a task function with the given name.
Parameters
The name of the task function to check.
Returns TaskFunctionOperationResult
Whether the worker has a task function with the given name or not.
-list Task Function Names
Lists the names of the worker's task functions.
-Returns string[]
The names of the worker's task functions.
-Protected
messageWorker message listener.
+list Task Functions Properties
Lists the properties of the worker's task functions.
+Returns TaskFunctionProperties[]
The properties of the worker's task functions.
+Protected
messageWorker message listener.
Parameters
The received message.
-Returns void
remove Task Function
Removes a task function from the worker.
+Returns void
remove Task Function
Removes a task function from the worker.
Parameters
The name of the task function to remove.
Returns TaskFunctionOperationResult
Whether the task function existed and was removed or not.
-Protected
Readonly
runRuns the given task.
+Protected
Readonly
runRuns the given task.
Parameters
The task to execute.
-Returns void
Protected
Readonly
runRuns the given task function asynchronously.
+Returns void
Protected
Readonly
runRuns the given task function asynchronously.
Parameters
Task function that will be executed.
Input data for the task function.
-Returns void
Protected
Readonly
runRuns the given task function synchronously.
+Returns void
Protected
Readonly
runRuns the given task function synchronously.
Parameters
Task function that will be executed.
Input data for the task function.
-Returns void
Protected
sendSends task function names to the main worker.
-Returns void
Protected
Readonly
sendSends a message to main worker.
+Returns void
Protected
sendSends task functions properties to the main worker.
+Returns void
Protected
Readonly
sendSends a message to main worker.
Parameters
The response message.
-Returns void
set Default Task Function
Sets the default task function to use in the worker.
+Returns void
set Default Task Function
Sets the default task function to use in the worker.
Parameters
The name of the task function to use as default task function.
Returns TaskFunctionOperationResult
Whether the default task function was set or not.
-Settings
Member Visibility
Theme
On This Page