Class 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

AbstractWorker
- ClusterWorker
- ThreadWorker

Constructors

constructor

new AbstractWorker<MainWorker, Data, Response>(isMain, mainWorker, taskFunctions, opts?): AbstractWorker<MainWorker, Data, Response>
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: TaskFunction<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>
- Defined in src/worker/abstract-worker.ts:88

Properties

`Protected` `Optional` activeInterval

activeInterval?: Timeout

Handler id of the activeInterval worker activity check.

`Protected` `Abstract` id

id: number

Worker id.

`Protected` `Readonly` isMain

isMain: boolean

Whether this is the main worker or not.

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

Timestamp of the last task processed by this worker.

`Private` `Readonly` mainWorker

mainWorker: MainWorker

Reference to main worker.

`Protected` opts

opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

Options for the worker.

`Protected` statistics

statistics: WorkerStatistics

Performance statistics computation requirements.

`Protected` taskFunctions

taskFunctions: Map<string, TaskFunction<Data, Response>>

Task function(s) processed by the worker when the pool's execution function is invoked.

Methods

addTaskFunction

addTaskFunction(name, fn): TaskFunctionOperationResult
Adds a task function to the worker. +AbstractWorker | poolifier - v4.0.2
Preparing search index...
The search index is not available
poolifier - v4.0.2
poolifier
AbstractWorker
Class 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)
AbstractWorker
ClusterWorker
ThreadWorker
Defined in src/worker/abstract-worker.ts:58
Index
Constructors
constructor +
Properties
activeInterval? +id +isMain +lastTaskTimestamp +mainWorker +opts +statistics? +taskFunctions +
Methods
addTaskFunction +beginTaskPerformance +checkActive +checkMessageWorkerId +checkTaskFunctions +checkWorkerOptions +endTaskPerformance +getMainWorker +handleError +handleKillMessage +handleReadyMessage +handleTaskFunctionOperationMessage +hasTaskFunction +listTaskFunctionsProperties +messageListener +removeTaskFunction +run +runAsync +runSync +sendTaskFunctionsPropertiesToMainWorker +sendToMainWorker +setDefaultTaskFunction +startCheckActive +stopCheckActive +updateLastTaskTimestamp +
Constructors
constructor
new AbstractWorker<MainWorker, Data, Response>(isMain, mainWorker, taskFunctions, opts?): AbstractWorker<MainWorker, Data, Response>
Constructs a new poolifier 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: TaskFunction<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>
Defined in src/worker/abstract-worker.ts:92
Properties
Protected Optional activeInterval
activeInterval?: Timeout
Handler id of the activeInterval worker activity check.
+
Defined in src/worker/abstract-worker.ts:82
Protected Abstract id
id: number
Worker id.
+
Defined in src/worker/abstract-worker.ts:66
Protected Readonly isMain
isMain: undefined | boolean
Whether this is the main worker or not.
+
Defined in src/worker/abstract-worker.ts:93
Protected lastTaskTimestamp
lastTaskTimestamp: number
Timestamp of the last task processed by this worker.
+
Defined in src/worker/abstract-worker.ts:74
Private Readonly mainWorker
mainWorker: undefined | null | MainWorker
Reference to main worker.
+
Defined in src/worker/abstract-worker.ts:94
Protected opts
opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
Options for the worker.
+
Defined in src/worker/abstract-worker.ts:96
Protected Optional statistics
statistics?: WorkerStatistics
Performance statistics computation requirements.
+
Defined in src/worker/abstract-worker.ts:78
Protected taskFunctions
taskFunctions: Map<string, TaskFunctionObject<Data, Response>>
Task function object(s) processed by the worker when the pool's execution function is invoked.
+
Defined in src/worker/abstract-worker.ts:70
Methods
addTaskFunction
addTaskFunction(name, fn): TaskFunctionOperationResult
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.
+
Parameters
name: string
The name of the task function to add.
+
fn: TaskFunctionObject<Data, Response> | TaskFunction<Data, Response>
The task function to add.

Returns TaskFunctionOperationResult
Whether the task function was added or not.
-
Defined in src/worker/abstract-worker.ts:176
Private beginTaskPerformance
beginTaskPerformance(name?): TaskPerformance
Parameters
Optional name: string
Returns TaskPerformance
Defined in src/worker/abstract-worker.ts:579
Private checkActive
checkActive(): void
Checks if the worker should be terminated, because its living too long.
-
Returns void
Defined in src/worker/abstract-worker.ts:430
Private checkMessageWorkerId
checkMessageWorkerId(message): void
Check if the message worker id is set and matches the worker id.
-
Parameters
message: MessageValue<Data, unknown>
The message to check.
+
Defined in src/worker/abstract-worker.ts:189
Private beginTaskPerformance
beginTaskPerformance(name?): TaskPerformance
Parameters
Optional name: string
Returns TaskPerformance
Defined in src/worker/abstract-worker.ts:614
Private checkActive
checkActive(): void
Checks if the worker should be terminated, because its living too long.
+
Returns void
Defined in src/worker/abstract-worker.ts:462
Private checkMessageWorkerId
checkMessageWorkerId(message): void
Check 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.
-
Defined in src/worker/abstract-worker.ts:396
Private checkStatistics
checkStatistics(): void
Returns void
Defined in src/worker/abstract-worker.ts:603
Private checkTaskFunctions
checkTaskFunctions(taskFunctions): void
Checks if the taskFunctions parameter is passed to the constructor and valid.
-
Parameters
taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
The task function(s) parameter that should be checked.
-
Returns void
Defined in src/worker/abstract-worker.ts:115
Private checkWorkerOptions
checkWorkerOptions(opts): void
Parameters
opts: WorkerOptions
Returns void
Defined in src/worker/abstract-worker.ts:105
Private endTaskPerformance
endTaskPerformance(taskPerformance): TaskPerformance
Parameters
taskPerformance: TaskPerformance
Returns TaskPerformance
Defined in src/worker/abstract-worker.ts:588
Protected getMainWorker
getMainWorker(): MainWorker
Returns the main worker.
-
Returns MainWorker
Reference to the main worker.
+
- Defined in src/worker/abstract-worker.ts:428

`Private` checkTaskFunctions

checkTaskFunctions(taskFunctions): void
Checks if the taskFunctions parameter 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
- Defined in src/worker/abstract-worker.ts:119

`Private` checkWorkerOptions

checkWorkerOptions(opts): void
Parameters
- opts: WorkerOptions
Returns void
- Defined in src/worker/abstract-worker.ts:109

`Private` endTaskPerformance

endTaskPerformance(taskPerformance): TaskPerformance
Parameters
- taskPerformance: TaskPerformance
Returns TaskPerformance
- Defined in src/worker/abstract-worker.ts:627

`Protected` getMainWorker

getMainWorker(): MainWorker
Returns 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.
-
- Defined in src/worker/abstract-worker.ts:445

`Protected` handleError

handleError(error): string
Handles 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.
  +
  - Defined in src/worker/abstract-worker.ts:477

`Protected` handleError

handleError(error): string
Handles 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.
-
- Defined in src/worker/abstract-worker.ts:476

`Protected` handleKillMessage

handleKillMessage(_message): void
Handles a kill message sent by the main worker.
-
Parameters
- _message: MessageValue<Data, unknown>
Returns void
- Defined in src/worker/abstract-worker.ts:368

`Protected` `Abstract` handleReadyMessage

handleReadyMessage(message): void
Handles the ready message sent by the main worker.
-
Parameters
- message: MessageValue<Data, unknown>
  The ready message.
  -
Returns void
- Defined in src/worker/abstract-worker.ts:296

`Protected` handleTaskFunctionOperationMessage

handleTaskFunctionOperationMessage(message): void
Parameters
- message: MessageValue<Data, unknown>
Returns void
- Defined in src/worker/abstract-worker.ts:323

hasTaskFunction

hasTaskFunction(name): TaskFunctionOperationResult
Checks if the worker has a task function with the given name.
-
Parameters
- name: string
  The name of the task function to check.
  +
  Defined in src/worker/abstract-worker.ts:508

`Protected` handleKillMessage

handleKillMessage(_message): void
Handles a kill message sent by the main worker.
+
Parameters
- _message: MessageValue<Data, unknown>
Returns void
- Defined in src/worker/abstract-worker.ts:400

`Protected` `Abstract` handleReadyMessage

handleReadyMessage(message): void
Handles the ready message sent by the main worker.
+
Parameters
- message: MessageValue<Data, unknown>
  The ready message.
  +
Returns void
- Defined in src/worker/abstract-worker.ts:318

`Protected` handleTaskFunctionOperationMessage

handleTaskFunctionOperationMessage(message): void
Parameters
- message: MessageValue<Data, unknown>
Returns void
- Defined in src/worker/abstract-worker.ts:345

hasTaskFunction

hasTaskFunction(name): TaskFunctionOperationResult
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.
-
- Defined in src/worker/abstract-worker.ts:159

listTaskFunctionNames

listTaskFunctionNames(): string[]
Lists the names of the worker's task functions.
-
Returns string[]
The names of the worker's task functions.
-
- Defined in src/worker/abstract-worker.ts:240

`Protected` messageListener

messageListener(message): void
Worker message listener.
-
Parameters
- message: MessageValue<Data, unknown>
  The received message.
  -
Returns void
- Defined in src/worker/abstract-worker.ts:303

removeTaskFunction

removeTaskFunction(name): TaskFunctionOperationResult
Removes a task function from the worker.
-
Parameters
- name: string
  The name of the task function to remove.
  +
  Defined in src/worker/abstract-worker.ts:172

listTaskFunctionsProperties

listTaskFunctionsProperties(): TaskFunctionProperties[]
Lists the properties of the worker's task functions.
+
Returns TaskFunctionProperties[]
The properties of the worker's task functions.
+
- Defined in src/worker/abstract-worker.ts:254

`Protected` messageListener

messageListener(message): void
Worker message listener.
+
Parameters
- message: MessageValue<Data, unknown>
  The received message.
  +
Returns void
- Defined in src/worker/abstract-worker.ts:325

removeTaskFunction

removeTaskFunction(name): TaskFunctionOperationResult
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.
-
- Defined in src/worker/abstract-worker.ts:211

`Protected` `Readonly` run

run(task): void
Runs the given task.
-
Parameters
- task: Task<Data>
  The task to execute.
  -
Returns void
- Defined in src/worker/abstract-worker.ts:485

`Protected` `Readonly` runAsync

runAsync(fn, task): void
Runs 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
- Defined in src/worker/abstract-worker.ts:547

`Protected` `Readonly` runSync

runSync(fn, task): void
Runs 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
- Defined in src/worker/abstract-worker.ts:513

`Protected` sendTaskFunctionNamesToMainWorker

sendTaskFunctionNamesToMainWorker(): void
Sends task function names to the main worker.
-
Returns void
- Defined in src/worker/abstract-worker.ts:464

`Protected` `Abstract` sendToMainWorker

sendToMainWorker(message): void
Sends a message to main worker.
-
Parameters
- message: MessageValue<Response, Data>
  The response message.
  -
Returns void
- Defined in src/worker/abstract-worker.ts:457

setDefaultTaskFunction

setDefaultTaskFunction(name): TaskFunctionOperationResult
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.
  +
  Defined in src/worker/abstract-worker.ts:225

`Protected` `Readonly` run

run(task): void
Runs the given task.
+
Parameters
- task: Task<Data>
  The task to execute.
  +
Returns void
- Defined in src/worker/abstract-worker.ts:517

`Protected` `Readonly` runAsync

runAsync(fn, task): void
Runs 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
- Defined in src/worker/abstract-worker.ts:581

`Protected` `Readonly` runSync

runSync(fn, task): void
Runs 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
- Defined in src/worker/abstract-worker.ts:546

`Protected` sendTaskFunctionsPropertiesToMainWorker

sendTaskFunctionsPropertiesToMainWorker(): void
Sends task functions properties to the main worker.
+
Returns void
- Defined in src/worker/abstract-worker.ts:496

`Protected` `Abstract` sendToMainWorker

sendToMainWorker(message): void
Sends a message to main worker.
+
Parameters
- message: MessageValue<Response, Data>
  The response message.
  +
Returns void
- Defined in src/worker/abstract-worker.ts:489

setDefaultTaskFunction

setDefaultTaskFunction(name): TaskFunctionOperationResult
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.
-
- Defined in src/worker/abstract-worker.ts:267

`Private` startCheckActive

startCheckActive(): void
Starts the worker check active interval.
-
Returns void
- Defined in src/worker/abstract-worker.ts:409

`Private` stopCheckActive

stopCheckActive(): void
Stops the worker check active interval.
-
Returns void
- Defined in src/worker/abstract-worker.ts:420

`Private` updateLastTaskTimestamp

updateLastTaskTimestamp(): void
Returns void
- Defined in src/worker/abstract-worker.ts:609

Class AbstractWorker<MainWorker, Data, Response>Abstract

Type Parameters

MainWorker extends Worker | MessagePort

Data = unknown

Response = unknown

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

MainWorker extends MessagePort | Worker

Data = unknown

Response = unknown

Parameters

isMain: boolean

mainWorker: MainWorker

taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>

opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

Returns AbstractWorker<MainWorker, Data, Response>

Properties

Protected Optional activeInterval

Protected Abstract id

Protected Readonly isMain

Protected lastTaskTimestamp

Private Readonly mainWorker

Protected opts

Protected statistics

Protected taskFunctions

Methods

addTaskFunction

Class AbstractWorker<MainWorker, Data, Response>Abstract

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AbstractWorker<MainWorker, Data, Response>

Properties

Protected Optional activeInterval

Protected Abstract id

Protected Readonly isMain

Protected lastTaskTimestamp

Private Readonly mainWorker

Protected opts

Protected Optional statistics

Protected taskFunctions

Methods

addTaskFunction

Parameters

name: string

fn: TaskFunction<Data, Response>

Parameters

Returns TaskFunctionOperationResult

Private beginTaskPerformance

Parameters

Optional name: string

Returns TaskPerformance

Private checkActive

Returns void

Private checkMessageWorkerId

Parameters

message: MessageValue<Data, unknown>

Private beginTaskPerformance

Parameters

Returns TaskPerformance

Private checkActive

Returns void

Private checkMessageWorkerId

Parameters

Returns void

Throws

Private checkStatistics

Class AbstractWorker<MainWorker, Data, Response>`Abstract`

`Protected` `Optional` activeInterval

`Protected` `Abstract` id

`Protected` `Readonly` isMain

`Protected` lastTaskTimestamp

`Private` `Readonly` mainWorker

`Protected` opts

`Protected` statistics

`Protected` taskFunctions

Class AbstractWorker<MainWorker, Data, Response>`Abstract`

`Protected` `Optional` activeInterval

`Protected` `Abstract` id

`Protected` `Readonly` isMain

`Protected` lastTaskTimestamp

`Private` `Readonly` mainWorker

`Protected` opts

`Protected` `Optional` statistics

`Protected` taskFunctions

`Private` beginTaskPerformance

`Optional` name: string

`Private` checkActive

`Private` checkMessageWorkerId

`Private` beginTaskPerformance

`Private` checkActive

`Private` checkMessageWorkerId

`Private` checkStatistics

`Private` checkTaskFunctions

`Private` checkWorkerOptions

`Private` endTaskPerformance

`Protected` getMainWorker

`Private` checkTaskFunctions

`Private` checkWorkerOptions

`Private` endTaskPerformance

`Protected` getMainWorker

`Protected` handleError

`Protected` handleError

`Protected` handleKillMessage

`Protected` `Abstract` handleReadyMessage

`Protected` handleTaskFunctionOperationMessage

`Protected` handleKillMessage

`Protected` `Abstract` handleReadyMessage

`Protected` handleTaskFunctionOperationMessage

`Protected` messageListener