X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=d7941f18ba38330ad7a33ff345da8665577b519d;hb=08f2acf02a5361dfe1b9ead740a5c0790af0e442;hp=0bd749ac96fcc6977bb680ce93e3dd52d3e6235c;hpb=5a8cac091245f45e5cf4e919d4defcbab916f783;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 0bd749ac..d7941f18 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,21 +1,20 @@ -
Abstract
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.18Class AbstractWorker<MainWorker, Data, Response>
Abstract
Base 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.
+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: TaskSyncFunction<Data, Response> | TaskAsyncFunction<Data, Response> | TaskFunctions<Data, Response>
Task function(s) processed by the worker when the pool's
execution
function is invoked. The first function is the default function.opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
Options for the worker.
-Returns AbstractWorker<MainWorker, Data, Response>
Properties
Protected
Optional
activeHandler id of the
-activeInterval
worker activity check.Protected
Abstract
idWorker id.
-Protected
Readonly
isWhether this is the main worker or not.
-Protected
lastTimestamp of the last task processed by this worker.
-Private
Readonly
mainReference to main worker.
-Protected
optsOptions for the worker.
-Protected
statisticsPerformance statistics computation requirements.
-Protected
taskTask function(s) processed by the worker when the pool's
-execution
function is invoked.Methods
add Task Function
Adds a task function to the worker. +
Returns AbstractWorker<MainWorker, Data, Response>
Properties
Protected
Optional
activeHandler id of the
+activeInterval
worker activity check.Protected
Abstract
idWorker id.
+Protected
Readonly
isWhether this is the main worker or not.
+Protected
lastTimestamp of the last task processed by this worker.
+Private
Readonly
mainReference to main 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.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
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.
-Private
beginParameters
Optional
name: stringReturns TaskPerformance
Private
checkChecks if the worker should be terminated, because its living too long.
-Returns void
Private
checkCheck if the message worker id is set and matches the worker id.
+Private
beginParameters
Optional
name: stringReturns TaskPerformance
Private
checkChecks if the worker should be terminated, because its living too long.
+Returns void
Private
checkCheck 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.
-Private
checkReturns void
Private
checkChecks if the
-taskFunctions
parameter 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
Private
checkParameters
opts: WorkerOptions
Returns void
Private
endParameters
taskPerformance: TaskPerformance
Returns TaskPerformance
Protected
getReturns the main worker.
+Private
checkChecks if the
+taskFunctions
parameter is passed to the constructor and valid.Parameters
taskFunctions: undefined | TaskSyncFunction<Data, Response> | TaskAsyncFunction<Data, Response> | TaskFunctions<Data, Response>
The task function(s) parameter that should be checked.
+Returns void
Private
checkParameters
opts: WorkerOptions
Returns void
Private
endParameters
taskPerformance: TaskPerformance
Returns TaskPerformance
Protected
getReturns 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.
-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
error: string | Error
The error raised by the worker.
Returns string
The error message.
-Protected
handleHandles a kill message sent by the main worker.
-Parameters
_message: MessageValue<Data, unknown>
Returns void
Protected
Abstract
handleHandles the ready message sent by the main worker.
+Protected
handleHandles a kill message sent by the main worker.
+Parameters
_message: MessageValue<Data, unknown>
Returns void
Protected
Abstract
handleHandles the ready message sent by the main worker.
Parameters
message: MessageValue<Data, unknown>
The ready message.
-Returns void
Protected
handleParameters
message: MessageValue<Data, unknown>
Returns void
has Task Function
Checks if the worker has a task function with the given name.
+Returns void
Protected
handleParameters
message: MessageValue<Data, unknown>
Returns void
has Task Function
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 Task Function Names
Lists the names of the worker's task functions.
+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.
+Protected
messageWorker message listener.
Parameters
message: MessageValue<Data, unknown>
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
name: string
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
task: Task<Data>
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
fn: TaskAsyncFunction<Data, Response>
Task function that will be executed.
task: Task<Data>
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
fn: TaskSyncFunction<Data, Response>
Task function that will be executed.
task: Task<Data>
Input data for the task function.
-Returns void
Protected
sendSends task function names to the main worker.
-Returns void
Protected
Abstract
sendSends a message to main worker.
+Returns void
Protected
sendSends task function names to the main worker.
+Returns void
Protected
Abstract
sendSends a message to main worker.
Parameters
message: MessageValue<Response, Data>
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
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.
-Private
startStarts the worker check active interval.
-Returns void
Private
stopStops the worker check active interval.
-Returns void
Private
updateReturns void
Settings
Member Visibility
Theme
On This Page
Generated using TypeDoc
Private
startStarts the worker check active interval.
+Returns void
Private
stopStops the worker check active interval.
+Returns void
Private
updateReturns void
Settings
Member Visibility
Theme
On This Page