X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FClusterWorker.html;h=52c4e2d42d36cd9f73144e92dd53edf39ffa5079;hb=c4a517416ff2c029d91a4ed006b94b23efb7d7a3;hp=97f72d62a4d863d540ccafb718ecd58915e097e6;hpb=3e030cbac2cbd1043c9dfdee6580ce494cbc50a1;p=poolifier.git
diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html
index 97f72d62..52c4e2d4 100644
--- a/docs/classes/ClusterWorker.html
+++ b/docs/classes/ClusterWorker.html
@@ -1,18 +1,18 @@
-ClusterWorker | poolifier - v3.1.4Class ClusterWorker<Data, Response>
A cluster worker used by a poolifier
+ClusterPool.- Preparing search index...
- The search index is not available
poolifier - v3.1.21Class 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
Data = unknown
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 structured-cloneable data.
-Hierarchy
Index
Constructors
Type Parameters
Data = unknown
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 structured-cloneable data.
+Hierarchy (view full)
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Constructs a new poolifier cluster worker.
-Type Parameters
Data = unknown
Response = unknown
Parameters
taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
Task function(s) processed by the worker when the pool's
+executionfunction is invoked.Constructors
constructor
Constructs a new poolifier cluster worker.
+Type Parameters
Data = unknown
Response = unknown
Parameters
taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
Task function(s) processed by the worker when the pool's
executionfunction is invoked.opts: WorkerOptions = {}
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.
-ProtectedstatisticsPerformance statistics computation requirements.
-ProtectedtaskTask function(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(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
name: string
The name of the task function to add.
-fn: TaskFunction<Data, Response>
The task function to add.
+fn: TaskFunction<Data, Response>
The task function to add.
Returns TaskFunctionOperationResult
Whether the task function was added or not.
-ProtectedgetReturns the main worker.
-Returns Worker
Reference to 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.
-Parameters
error: string | Error
The error raised by the worker.
+ProtectedhandleHandles an error and convert it to a string so it can be sent back to the main worker.
+Parameters
error: string | Error
The error raised by the worker.
Returns string
The error message.
-ProtectedhandleHandles a kill message sent by the main worker.
-Parameters
_message: MessageValue<Data, unknown>
Returns void
ProtectedhandleHandles the ready message sent by the main worker.
-Parameters
message: MessageValue<Data, unknown>
The ready message.
-Returns void
ProtectedhandleParameters
message: MessageValue<Data, unknown>
Returns void
has
Checks if the worker has a task function with the given name.
+ProtectedhandleHandles a kill message sent by the main worker.
+Parameters
_message: MessageValue<Data, unknown>
Returns void
ProtectedhandleHandles the ready message sent by the main worker.
+Parameters
message: MessageValue<Data, unknown>
The ready message.
+Returns void
ProtectedhandleParameters
message: MessageValue<Data, unknown>
Returns void
has
Checks if the worker has a task function with the given name.
Parameters
name: string
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 names of the worker's task functions.
+list
Lists the names of the worker's task functions.
Returns string[]
The names of the worker's task functions.
-ProtectedmessageWorker message listener.
-Parameters
message: MessageValue<Data, unknown>
The received message.
-Returns void
remove
Removes a task function from the worker.
+ProtectedmessageWorker message listener.
+Parameters
message: MessageValue<Data, unknown>
The received message.
+Returns void
remove
Removes a task function from the worker.
Parameters
name: string
The name of the task function to remove.
Returns TaskFunctionOperationResult
Whether the task function existed and was removed or not.
-ProtectedReadonlyrunRuns the given task.
-Parameters
task: Task<Data>
The task to execute.
-Returns void
ProtectedReadonlyrunRuns the given task function asynchronously.
-Parameters
fn: TaskAsyncFunction<Data, Response>
Task function that will be executed.
-task: Task<Data>
Input data for the task function.
-Returns void
ProtectedReadonlyrunRuns the given task function synchronously.
-Parameters
fn: TaskSyncFunction<Data, Response>
Task function that will be executed.
-task: Task<Data>
Input data for the task function.
-Returns void
ProtectedsendSends task function names to the main worker.
-Returns void
ProtectedReadonlysendSends a message to main worker.
-Parameters
message: MessageValue<Response, unknown>
The response message.
-Returns void
set
Sets the default task function to use in the worker.
+ProtectedReadonlyrunRuns the given task.
+Parameters
task: Task<Data>
The task to execute.
+Returns void
ProtectedReadonlyrunRuns the given task function asynchronously.
+Parameters
fn: TaskAsyncFunction<Data, Response>
Task function that will be executed.
+task: Task<Data>
Input data for the task function.
+Returns void
ProtectedReadonlyrunRuns the given task function synchronously.
+Parameters
fn: TaskSyncFunction<Data, Response>
Task function that will be executed.
+task: Task<Data>
Input data for the task function.
+Returns void
ProtectedsendSends task function names to the main worker.
+Returns void
ProtectedReadonlysendSends a message to main worker.
+Parameters
message: MessageValue<Response, unknown>
The response message.
+Returns void
set
Sets the default task function to use in the worker.
Parameters
name: string
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
Generated using TypeDoc
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc