A cluster worker used by a poolifier ClusterPool.
ClusterPool
When this worker is inactive for more than the given maxInactiveTime, it will send a termination request to its main worker.
maxInactiveTime
If you use a DynamicClusterPool the extra workers that were created will be terminated, but the minimum number of workers will be guaranteed.
DynamicClusterPool
Christopher Quadflieg
2.0.0
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.
Constructs a new poolifier cluster worker.
Task function(s) processed by the worker when the pool's execution function is invoked.
execution
Options for the worker.
Protected
Optional
Handler id of the activeInterval worker activity check.
activeInterval
Readonly
Whether this is the main worker or not.
Timestamp of the last task processed by this worker.
Performance statistics computation requirements.
Task function object(s) processed by the worker when the pool's execution function is invoked.
Worker id.
Adds a task function to the worker. +
Adds a task function to the worker. If a task function with the same name already exists, it is replaced.
The name of the task function to add.
The task function to add.
Whether the task function was added or not.
Returns the main worker.
Reference to the main worker.
https://nodejs.org/api/errors.html#class-error If the main worker is not set.
Handles an error and convert it to a string so it can be sent back to the main worker.
The error raised by the worker.
The error message.
Handles a kill message sent by the main worker.
The kill message.
Handles the ready message sent by the main worker.
The ready message.
Checks if the worker has a task function with the given name.
The name of the task function to check.
Whether the worker has a task function with the given name or not.
Lists the properties of the worker's task functions.
The properties of the worker's task functions.
Worker message listener.
The received message.
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.
Runs the given task.
The task to execute.
Runs the given task function asynchronously.
Task function that will be executed.
Input data for the task function.
Runs the given task function synchronously.
Sends task functions properties to the main worker.
Sends a message to main worker.
The response message.
Sets the default task function to use in the worker.
The name of the task function to use as default task function.
Whether the default task function was set or not.
A cluster worker used by a poolifier
+ClusterPool.- Preparing search index...
- The search index is not available
poolifier - v4.0.15Class 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
-DynamicClusterPoolthe extra workers that were created will be terminated, but the minimum number of workers will be guaranteed.Author
Christopher Quadflieg
-Since
2.0.0
-Type Parameters
Type of data this worker receives from pool's execution. This can only be structured-cloneable data.
+Author
Christopher Quadflieg
+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
+executionfunction is invoked.Constructors
constructor
Constructs a new poolifier cluster worker.
+Type Parameters
Parameters
Task function(s) processed by the worker when the pool's
executionfunction is invoked.Options for the worker.
-Returns ClusterWorker<Data, Response>
Properties
ProtectedOptionalactiveHandler id of the
-activeIntervalworker activity check.ProtectedReadonlyisWhether this is the main worker or not.
-ProtectedlastTimestamp of the last task processed by this worker.
-ProtectedoptsOptions for the worker.
-ProtectedOptionalstatisticsPerformance statistics computation requirements.
-ProtectedtaskTask function object(s) processed by the worker when the pool's
-executionfunction is invoked.Accessors
ProtectedidWorker id.
-Returns number
Methods
add
Adds a task function to the worker. +
Returns ClusterWorker<Data, Response>
Properties
ProtectedOptionalactiveHandler id of the
+activeIntervalworker activity check.ProtectedReadonlyisWhether this is the main worker or not.
+ProtectedlastTimestamp of the last task processed by this worker.
+ProtectedoptsOptions for the worker.
+ProtectedOptionalstatisticsPerformance statistics computation requirements.
+ProtectedtaskTask function object(s) processed by the worker when the pool's
+executionfunction is invoked.Accessors
ProtectedidWorker id.
+Returns number
Methods
add
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.
Returns TaskFunctionOperationResult
Whether the task function was added or not.
-ProtectedgetReturns the main worker.
+ProtectedgetReturns 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.
-ProtectedhandleHandles an error and convert it to a string so it can be sent back to the main worker.
+Throws
https://nodejs.org/api/errors.html#class-error If the main worker is not set.
+ProtectedhandleHandles 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.
-ProtectedhandleHandles a kill message sent by the main worker.
+ProtectedhandleHandles a kill message sent by the main worker.
Parameters
The kill message.
-Returns void
ProtectedhandleHandles the ready message sent by the main worker.
+Returns void
ProtectedhandleHandles the ready message sent by the main worker.
Parameters
The ready message.
-Returns void
ProtectedhandleParameters
Returns void
has
Checks if the worker has a task function with the given name.
+Returns void
ProtectedhandleParameters
Returns void
has
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
Lists the properties of the worker's task functions.
-Returns TaskFunctionProperties[]
The properties of the worker's task functions.
-ProtectedmessageWorker message listener.
+list
Lists the properties of the worker's task functions.
+Returns TaskFunctionProperties[]
The properties of the worker's task functions.
+ProtectedmessageWorker message listener.
Parameters
The received message.
-Returns void
remove
Removes a task function from the worker.
+Returns void
remove
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.
-ProtectedReadonlyrunRuns the given task.
+ProtectedReadonlyrunRuns the given task.
Parameters
The task to execute.
-Returns void
ProtectedReadonlyrunRuns the given task function asynchronously.
+Returns void
ProtectedReadonlyrunRuns the given task function asynchronously.
Parameters
Task function that will be executed.
Input data for the task function.
-Returns void
ProtectedReadonlyrunRuns the given task function synchronously.
+Returns void
ProtectedReadonlyrunRuns the given task function synchronously.
Parameters
Task function that will be executed.
Input data for the task function.
-Returns void
ProtectedsendSends task functions properties to the main worker.
-Returns void
ProtectedReadonlysendSends a message to main worker.
+Returns void
ProtectedsendSends task functions properties to the main worker.
+Returns void
ProtectedReadonlysendSends a message to main worker.
Parameters
The response message.
-Returns void
set
Sets the default task function to use in the worker.
+Returns void
set
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