Class ThreadWorker<Data, Response>

A thread worker used by a poolifier ThreadPool.

+ThreadWorker | poolifier - v3.1.17

Class ThreadWorker<Data, Response>

A thread worker used by a poolifier ThreadPool.

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

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

Since

0.0.1

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 thread. This can only be structured-cloneable data.
-

Hierarchy (view full)

AbstractWorker<MessagePort, Data, Response>
- ThreadWorker

Index

Constructors

constructor +

Hierarchy (view full)

AbstractWorker<MessagePort, Data, Response>
- ThreadWorker

Index

Constructors

constructor

Properties

activeInterval? isMain lastTaskTimestamp opts port? -statistics +statistics? taskFunctions

Accessors

Methods

addTaskFunction @@ -35,50 +35,50 @@ but the minimum number of workers will be guaranteed.

Constructors

constructor

new ThreadWorker<Data, Response>(taskFunctions, opts?): ThreadWorker<Data, Response>
Constructs a new poolifier thread 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.
- opts: WorkerOptions = {}
  Options for the worker.
  -
Returns ThreadWorker<Data, Response>
Overrides AbstractWorker.constructor
- Defined in src/worker/thread-worker.ts:41

Properties

`Protected` `Optional` activeInterval

activeInterval?: Timeout

Handler id of the activeInterval worker activity check.

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

`Protected` opts

opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

Options for the worker.

`Private` `Optional` port

port?: MessagePort

Message port used to communicate with the main 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.

Accessors

`Protected` id

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

Methods

addTaskFunction

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

Returns ThreadWorker<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.

`Private` `Optional` port

port?: MessagePort

Message port used to communicate with the main 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/thread-worker.ts:79

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:176

`Protected` getMainWorker

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

`Protected` getMainWorker

getMainWorker(): MessagePort
Returns the main worker.

Returns MessagePort
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:447

`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.
-
Overrides AbstractWorker.handleError
- Defined in src/worker/thread-worker.ts:95

`Protected` handleKillMessage

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

`Protected` handleReadyMessage

handleReadyMessage(message): void
Handles the ready message sent by the main worker.
+
Overrides AbstractWorker.handleError
- Defined in src/worker/thread-worker.ts:97

`Protected` handleKillMessage

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

`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/thread-worker.ts:50

`Protected` handleTaskFunctionOperationMessage

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

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:159

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:240

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

removeTaskFunction

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

Class ThreadWorker<Data, Response>

Class ThreadWorker<Data, Response>

Since

Type Parameters

Data = unknown

Response = unknown

Hierarchy (view full)

Index

Constructors

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Data = unknown

Response = unknown

Parameters

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

opts: WorkerOptions = {}

Returns ThreadWorker<Data, Response>

Properties

Protected Optional activeInterval

Protected Readonly isMain

Protected lastTaskTimestamp

Protected opts

Private Optional port

Protected statistics

Protected taskFunctions

Accessors

Protected id

Returns number

Methods

addTaskFunction

Returns ThreadWorker<Data, Response>

Properties

Protected Optional activeInterval

Protected Readonly isMain

Protected lastTaskTimestamp

Protected opts

Private Optional port

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 MessagePort

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

message: MessageValue<Data, unknown>

`Protected` `Optional` activeInterval

`Protected` `Readonly` isMain

`Protected` lastTaskTimestamp

`Protected` opts

`Private` `Optional` port

`Protected` statistics

`Protected` taskFunctions

`Protected` id

`Protected` `Optional` activeInterval

`Protected` `Readonly` isMain

`Protected` lastTaskTimestamp

`Protected` opts

`Private` `Optional` port

`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