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

Base class that implements some shared logic for all poolifier workers.

+AbstractWorker | poolifier - v3.1.12

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

Index

Constructors

constructor +

Hierarchy

AbstractWorker
- ClusterWorker
- ThreadWorker

Index

Constructors

constructor

Properties

activeInterval? id isMain @@ -42,58 +42,58 @@

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>

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. +

Returns AbstractWorker<MainWorker, Data, Response>

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. 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.
-
- 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.
+
- 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.
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.
+
- 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 void

`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.

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.
+
- 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.
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.
+
- 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.
+

Class AbstractWorker<MainWorker, Data, Response>Abstract

Class AbstractWorker<MainWorker, Data, Response>Abstract

Type Parameters

MainWorker extends Worker | MessagePort

Data = unknown

Response = unknown

Hierarchy

Index

Constructors

Hierarchy

Index

Constructors

Properties

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

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

Parameters

name: string

fn: TaskFunction<Data, Response>

Returns TaskFunctionOperationResult

Private beginTaskPerformance

Parameters

Optional name: string

Returns TaskPerformance

Private checkActive

Returns void

Private checkMessageWorkerId

Private beginTaskPerformance

Parameters

Optional name: string

Returns TaskPerformance

Private checkActive

Returns void

Private checkMessageWorkerId

Parameters

message: MessageValue<Data, unknown>

Returns void

Throws

Private checkStatistics

Returns void

Private checkTaskFunctions

Private checkStatistics

Returns void

Private checkTaskFunctions

Parameters

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

Returns void

Private checkWorkerOptions

Parameters

opts: WorkerOptions

Returns void

Private endTaskPerformance

Parameters

taskPerformance: TaskPerformance

Returns TaskPerformance

Protected getMainWorker

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

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

`Protected` `Optional` activeInterval

`Protected` `Abstract` id

`Protected` `Readonly` isMain

`Protected` lastTaskTimestamp

`Private` `Readonly` mainWorker

`Protected` opts

`Protected` statistics

`Protected` taskFunctions

`Private` beginTaskPerformance

`Optional` name: string

`Private` checkActive

`Private` checkMessageWorkerId

`Private` beginTaskPerformance

`Optional` name: string

`Private` checkActive

`Private` checkMessageWorkerId

`Private` checkStatistics

`Private` checkTaskFunctions

`Private` checkStatistics

`Private` checkTaskFunctions

`Private` checkWorkerOptions

`Private` endTaskPerformance

`Protected` getMainWorker

`Private` checkWorkerOptions

`Private` endTaskPerformance

`Protected` getMainWorker

`Protected` handleError

`Protected` handleError

`Protected` handleKillMessage

`Protected` `Abstract` handleReadyMessage

`Protected` handleKillMessage

`Protected` `Abstract` handleReadyMessage

`Protected` handleTaskFunctionOperationMessage

`Protected` handleTaskFunctionOperationMessage

`Protected` messageListener

`Protected` messageListener

`Protected` `Readonly` run

`Protected` `Readonly` run

`Protected` `Readonly` runAsync

`Protected` `Readonly` runAsync