Abstract
Base class that implements some shared logic for all poolifier workers.
Type of main worker.
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 worker.
Whether this is the main worker or not.
Reference to main worker.
Task function(s) processed by the worker when the pool's execution function is invoked. The first function is the default function.
execution
Options for the worker.
Protected
Optional
Handler id of the activeInterval worker activity check.
activeInterval
Worker id.
Readonly
Timestamp of the last task processed by this worker.
Private
Performance statistics computation requirements.
Task function(s) processed by the worker when the pool's execution function is invoked.
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.
Checks if the worker should be terminated, because its living too long.
Check if the message worker id is set and matches the worker id.
The message to check.
https://nodejs.org/api/errors.html#class-error If the message worker id is not set or does not match the worker id.
Checks if the taskFunctions parameter is passed to the constructor and valid.
taskFunctions
The task function(s) parameter that should be checked.
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.
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 names of the worker's task functions.
The names 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 function names 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.
Starts the worker check active interval.
Stops the worker check active interval.
Generated using TypeDoc
Base class that implements some shared logic for all poolifier workers.
+- Preparing search index...
- The search index is not available
poolifier - v3.1.19Class AbstractWorker<MainWorker, Data, Response>
AbstractBase class that implements some shared logic for all poolifier workers.
Type Parameters
MainWorker extends Worker | MessagePort
Type of main worker.
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
Hierarchy (view full)
Index
Constructors
Properties
Methods
Constructors
constructor
Constructs a new poolifier worker.
-Type Parameters
MainWorker extends MessagePort | Worker
Data = unknown
Response = unknown
Parameters
isMain: boolean
Whether this is the main worker or not.
-mainWorker: MainWorker
Reference to main worker.
-taskFunctions: TaskSyncFunction<Data, Response> | TaskAsyncFunction<Data, Response> | TaskFunctions<Data, Response>
Task function(s) processed by the worker when the pool's
+executionfunction is invoked. The first function is the default function.Type Parameters
MainWorker extends MessagePort | Worker
Data = unknown
Response = unknown
Parameters
isMain: undefined | boolean
Whether this is the main worker or not.
+mainWorker: undefined | null | MainWorker
Reference to main worker.
+taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
Task function(s) processed by the worker when the pool's
executionfunction is invoked. The first function is the default function.opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
Options for the worker.
-Returns AbstractWorker<MainWorker, Data, Response>
Properties
ProtectedOptionalactiveHandler id of the
-activeIntervalworker activity check.ProtectedAbstractidWorker id.
-ProtectedReadonlyisWhether this is the main worker or not.
-ProtectedlastTimestamp of the last task processed by this worker.
-PrivateReadonlymainReference to main worker.
-ProtectedoptsOptions for the worker.
-ProtectedstatisticsPerformance statistics computation requirements.
-ProtectedtaskTask function(s) processed by the worker when the pool's
-executionfunction is invoked.Methods
add
Adds a task function to the worker. +
Returns AbstractWorker<MainWorker, Data, Response>
Properties
ProtectedOptionalactiveHandler id of the
+activeIntervalworker activity check.ProtectedAbstractidWorker id.
+ProtectedReadonlyisWhether this is the main worker or not.
+ProtectedlastTimestamp of the last task processed by this worker.
+PrivateReadonlymainReference to main worker.
+ProtectedoptsOptions for the worker.
+ProtectedOptionalstatisticsPerformance statistics computation requirements.
+ProtectedtaskTask function(s) processed by the worker when the pool's
+executionfunction is invoked.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.
Returns TaskFunctionOperationResult
Whether the task function was added or not.
-PrivatebeginParameters
Optionalname: stringReturns TaskPerformance
PrivatecheckChecks if the worker should be terminated, because its living too long.
-Returns void
PrivatecheckCheck if the message worker id is set and matches the worker id.
+PrivatebeginParameters
Optionalname: stringReturns TaskPerformance
PrivatecheckChecks if the worker should be terminated, because its living too long.
+Returns void
PrivatecheckCheck if the message worker id is set and matches the worker id.
Parameters
message: MessageValue<Data, unknown>
The message to check.
Returns void
Throws
https://nodejs.org/api/errors.html#class-error If the message worker id is not set or does not match the worker id.
-PrivatecheckReturns void
PrivatecheckChecks if the
-taskFunctionsparameter is passed to the constructor and valid.Parameters
taskFunctions: TaskSyncFunction<Data, Response> | TaskAsyncFunction<Data, Response> | TaskFunctions<Data, Response>
The task function(s) parameter that should be checked.
-Returns void
PrivatecheckParameters
opts: WorkerOptions
Returns void
PrivateendParameters
taskPerformance: TaskPerformance
Returns TaskPerformance
ProtectedgetReturns the main worker.
+PrivatecheckChecks if the
+taskFunctionsparameter is passed to the constructor and valid.Parameters
taskFunctions: undefined | TaskFunction<Data, Response> | TaskFunctions<Data, Response>
The task function(s) parameter that should be checked.
+Returns void
PrivatecheckParameters
opts: WorkerOptions
Returns void
PrivateendParameters
taskPerformance: TaskPerformance
Returns TaskPerformance
ProtectedgetReturns the main worker.
Returns MainWorker
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.
+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
ProtectedAbstracthandleHandles the ready message sent by the main worker.
+ProtectedhandleHandles a kill message sent by the main worker.
+Parameters
_message: MessageValue<Data, unknown>
Returns void
ProtectedAbstracthandleHandles 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.
+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.
+ProtectedmessageWorker message listener.
Parameters
message: MessageValue<Data, unknown>
The received message.
-Returns void
remove
Removes a task function from the worker.
+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.
+ProtectedReadonlyrunRuns the given task.
Parameters
task: Task<Data>
The task to execute.
-Returns void
ProtectedReadonlyrunRuns the given task function asynchronously.
+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.
+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
ProtectedAbstractsendSends a message to main worker.
+Returns void
ProtectedsendSends task function names to the main worker.
+Returns void
ProtectedAbstractsendSends a message to main worker.
Parameters
message: MessageValue<Response, Data>
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
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.
-PrivatestartStarts the worker check active interval.
-Returns void
PrivatestopStops the worker check active interval.
-Returns void
PrivateupdateReturns void
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc
PrivatestartStarts the worker check active interval.
+Returns void
PrivatestopStops the worker check active interval.
+Returns void
PrivateupdateReturns void
Settings
Member Visibility
Theme
On This Page