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

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

+AbstractWorker | poolifier - v3.1.30

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

Index

Constructors

constructor +

Hierarchy (view full)

AbstractWorker
- ClusterWorker
- ThreadWorker

Index

Constructors

constructor

Properties

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

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>

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: undefined | 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: undefined | null | MainWorker

Reference to main worker.

`Protected` opts

opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

Options for the worker.

`Protected` `Optional` 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: undefined | 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: undefined | null | MainWorker

Reference to main worker.

`Protected` opts

opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

Options for the worker.

`Protected` `Optional` 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:180

`Private` beginTaskPerformance

beginTaskPerformance(name?): TaskPerformance
Parameters
- Optional name: string
Returns TaskPerformance
- Defined in src/worker/abstract-worker.ts:589

`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:437

`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:180

`Private` beginTaskPerformance

beginTaskPerformance(name?): TaskPerformance
Parameters
- Optional name: string
Returns TaskPerformance
- Defined in src/worker/abstract-worker.ts:589

`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:437

`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:403

`Private` checkTaskFunctions

checkTaskFunctions(taskFunctions): void
Checks if the taskFunctions parameter is passed to the constructor and valid.
+
- Defined in src/worker/abstract-worker.ts:403

`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:116

`Private` checkWorkerOptions

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

`Private` endTaskPerformance

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

`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:106

`Private` endTaskPerformance

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

`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:452

`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:452

`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:483

`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:375

`Protected` `Abstract` handleReadyMessage

handleReadyMessage(message): void
Handles the ready message sent by the main worker.
+
- Defined in src/worker/abstract-worker.ts:483

`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:375

`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:298

`Protected` handleTaskFunctionOperationMessage

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

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

Hierarchy (view full)

Index

Constructors

Hierarchy (view full)

Index

Constructors

Properties

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

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

Returns TaskFunctionOperationResult

Private beginTaskPerformance

Parameters

Returns TaskPerformance

Private checkActive

Returns void

Private checkMessageWorkerId

Private beginTaskPerformance

Parameters

Returns TaskPerformance

Private checkActive

Returns void

Private checkMessageWorkerId

Parameters

Returns void

Throws

Private checkTaskFunctions

Private checkTaskFunctions

Parameters

Returns void

Private checkWorkerOptions

Parameters

Returns void

Private endTaskPerformance

Parameters

Returns TaskPerformance

Protected getMainWorker

Returns void

Private checkWorkerOptions

Parameters

Returns void

Private endTaskPerformance

Parameters

Returns TaskPerformance

Protected getMainWorker

Returns MainWorker

Throws

Protected handleError

Protected handleError

Parameters

Returns string

Protected handleKillMessage

Parameters

Returns void

Protected Abstract handleReadyMessage

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` `Optional` statistics

`Protected` taskFunctions

`Protected` `Optional` activeInterval

`Protected` `Abstract` id

`Protected` `Readonly` isMain

`Protected` lastTaskTimestamp

`Private` `Readonly` mainWorker

`Protected` opts

`Protected` `Optional` statistics

`Protected` taskFunctions

`Private` beginTaskPerformance

`Private` checkActive

`Private` checkMessageWorkerId

`Private` beginTaskPerformance

`Private` checkActive

`Private` checkMessageWorkerId

`Private` checkTaskFunctions

`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

`Protected` `Readonly` runSync

`Protected` `Readonly` runSync

`Protected` sendTaskFunctionNamesToMainWorker

`Protected` `Abstract` sendToMainWorker

`Protected` sendTaskFunctionNamesToMainWorker

`Protected` `Abstract` sendToMainWorker

`Private` startCheckActive

`Private` stopCheckActive

`Private` updateLastTaskTimestamp

`Private` startCheckActive

`Private` stopCheckActive