Class ClusterWorker<Data, Response>

A cluster worker used by a poolifier ClusterPool.

+ClusterWorker | poolifier - v3.1.21

Class ClusterWorker<Data, Response>

A cluster worker used by a poolifier ClusterPool.

When this worker is inactive for more than the given maxInactiveTime, it will send a termination request to its main worker.

If you use a DynamicClusterPool the extra workers that were created will be terminated, @@ -7,7 +7,7 @@ but the minimum number of workers will be guaranteed.

Since

2.0.0

Type Parameters

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<Worker, Data, Response>
- ClusterWorker

Index

Constructors

constructor +

Hierarchy (view full)

AbstractWorker<Worker, Data, Response>
- ClusterWorker

Index

Constructors

constructor

Properties

activeInterval? isMain lastTaskTimestamp @@ -32,51 +32,51 @@ but the minimum number of workers will be guaranteed.

sendToMainWorker setDefaultTaskFunction

Constructors

constructor

new ClusterWorker<Data, Response>(taskFunctions, opts?): ClusterWorker<Data, Response>
Constructs a new poolifier cluster worker.
-
Type Parameters
- Data = unknown
- Response = unknown
Parameters
- 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.
  +
  Type Parameters
  - Data = unknown
  - Response = unknown
  Parameters
  - taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
    Task function(s) processed by the worker when the pool's execution function is invoked.
  - opts: WorkerOptions = {}
    Options for the worker.
    -
  Returns ClusterWorker<Data, Response>
  Overrides AbstractWorker.constructor
  - Defined in src/worker/cluster-worker.ts:31

Properties

`Protected` `Optional` activeInterval

activeInterval?: Timeout

Handler id of the activeInterval worker activity check.

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

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

Accessors

`Protected` id

get id(): number
Worker id.
-
Returns number
Overrides AbstractWorker.id
- Defined in src/worker/cluster-worker.ts:57

Methods

addTaskFunction

addTaskFunction(name, fn): TaskFunctionOperationResult
Adds a task function to the worker. +

Returns ClusterWorker<Data, Response>

Properties

`Protected` `Optional` activeInterval

activeInterval?: Timeout

Handler id of the activeInterval worker activity check.

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

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

Accessors

`Protected` id

get id(): number
Worker id.
+
Returns number
Overrides AbstractWorker.id
- Defined in src/worker/cluster-worker.ts:57

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.
-
Inherited from AbstractWorker.addTaskFunction
- Defined in src/worker/abstract-worker.ts:179

`Protected` getMainWorker

getMainWorker(): Worker
Returns the main worker.
+
Inherited from AbstractWorker.addTaskFunction
- Defined in src/worker/abstract-worker.ts:179

`Protected` getMainWorker

getMainWorker(): Worker
Returns the main worker.

Returns Worker
Reference to the main worker.

Throws
https://nodejs.org/api/errors.html#class-error If the main worker is not set.
-
Inherited from AbstractWorker.getMainWorker
- Defined in src/worker/abstract-worker.ts:451

`Protected` handleError

handleError(error): string
Handles an error and convert it to a string so it can be sent back to the main worker.
+
Inherited from AbstractWorker.getMainWorker
- Defined in src/worker/abstract-worker.ts:451

`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.
-
Inherited from AbstractWorker.handleError
- Defined in src/worker/abstract-worker.ts:482

`Protected` handleKillMessage

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

`Protected` handleReadyMessage

handleReadyMessage(message): void
Handles the ready message sent by the main worker.
+
Inherited from AbstractWorker.handleError
- Defined in src/worker/abstract-worker.ts:482

`Protected` handleKillMessage

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

`Protected` handleReadyMessage

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

`Protected` handleTaskFunctionOperationMessage

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

hasTaskFunction

hasTaskFunction(name): TaskFunctionOperationResult
Checks if the worker has a task function with the given name.
+

Returns void

`Protected` handleTaskFunctionOperationMessage

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

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.
-
Inherited from AbstractWorker.hasTaskFunction
- Defined in src/worker/abstract-worker.ts:162

listTaskFunctionNames

listTaskFunctionNames(): string[]
Lists the names of the worker's task functions.
+
Inherited from AbstractWorker.hasTaskFunction
- Defined in src/worker/abstract-worker.ts:162

listTaskFunctionNames

listTaskFunctionNames(): string[]
Lists the names of the worker's task functions.

Returns string[]
The names of the worker's task functions.
-
Inherited from AbstractWorker.listTaskFunctionNames
- Defined in src/worker/abstract-worker.ts:243

`Protected` messageListener

messageListener(message): void
Worker message listener.
+
Inherited from AbstractWorker.listTaskFunctionNames
- Defined in src/worker/abstract-worker.ts:243

`Protected` messageListener

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

removeTaskFunction

removeTaskFunction(name): TaskFunctionOperationResult
Removes a task function from the worker.
+

Class ClusterWorker<Data, Response>

Class ClusterWorker<Data, Response>

Since

Type Parameters

Data = unknown

Response = unknown

Hierarchy (view full)

Index

Constructors

Hierarchy (view full)

Index

Constructors

Properties

Constructors

constructor

Type Parameters

Data = unknown

Response = unknown

Parameters

taskFunctions: TaskSyncFunction<Data, Response> | TaskAsyncFunction<Data, Response> | TaskFunctions<Data, Response>

Type Parameters

Data = unknown

Response = unknown

Parameters

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

opts: WorkerOptions = {}

Returns ClusterWorker<Data, Response>

Properties

Protected Optional activeInterval

Protected Readonly isMain

Protected lastTaskTimestamp

Protected opts

Protected Optional statistics

Protected taskFunctions

Accessors

Protected id

Returns number

Methods

addTaskFunction

Returns ClusterWorker<Data, Response>

Properties

Protected Optional activeInterval

Protected Readonly isMain

Protected lastTaskTimestamp

Protected opts

Protected Optional statistics

Protected taskFunctions

Accessors

Protected id

Returns number

Methods

addTaskFunction

Parameters

name: string

fn: TaskFunction<Data, Response>

Returns TaskFunctionOperationResult

Protected getMainWorker

Protected getMainWorker

Returns Worker

Throws

Protected handleError

Protected handleError

Parameters

error: string | Error

Returns string

Protected handleKillMessage

Parameters

_message: MessageValue<Data, unknown>

Returns void

Protected handleReadyMessage

Protected handleKillMessage

Parameters

_message: MessageValue<Data, unknown>

Returns void

Protected handleReadyMessage

Parameters

message: MessageValue<Data, unknown>

Returns void

Protected handleTaskFunctionOperationMessage

Parameters

`Protected` `Optional` activeInterval

`Protected` `Readonly` isMain

`Protected` lastTaskTimestamp

`Protected` opts

`Protected` `Optional` statistics

`Protected` taskFunctions

`Protected` id

`Protected` `Optional` activeInterval

`Protected` `Readonly` isMain

`Protected` lastTaskTimestamp

`Protected` opts

`Protected` `Optional` statistics

`Protected` taskFunctions

`Protected` id

`Protected` getMainWorker

`Protected` getMainWorker

`Protected` handleError

`Protected` handleError

`Protected` handleKillMessage

`Protected` handleReadyMessage

`Protected` handleKillMessage

`Protected` 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` `Readonly` sendToMainWorker

`Protected` sendTaskFunctionNamesToMainWorker

`Protected` `Readonly` sendToMainWorker