Base class containing some shared logic for all poolifier workers.

Type parameters

MainWorker: Worker | MessagePort
-
Type of main worker.
-
Data = unknown
-
Type of data this worker receives from pool's execution. This can only be serializable data.
-
Response = unknown
-
Type of response the worker sends back to the main worker. This can only be serializable data.
-

Hierarchy

AsyncResource
- AbstractWorker
  - ClusterWorker
  - ThreadWorker

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AbstractWorker<MainWorker, Data, Response>(type: string, isMain: boolean, fn: (data: Data) => Response, mainWorker: undefined | null | MainWorker, opts?: WorkerOptions): AbstractWorker<MainWorker, Data, Response>

Overrides AsyncResource.constructor
- Defined in src/worker/abstract-worker.ts:42
-
Constructs a new poolifier worker.
-
Type parameters
- MainWorker: Worker | MessagePort
- Data = unknown
- Response = unknown
Parameters
- type: string
  -
  The type of async event.
  -
- isMain: boolean
  -
  Whether this is the main worker or not.
  -
- fn: (data: Data) => Response
  -
  Function processed by the worker when the pool's execution function is invoked.
  -
  - - (data: Data): Response
    - Parameters
      - data: Data
      Returns Response
- mainWorker: undefined | null | MainWorker
  -
  Reference to main worker.
  -
- opts: WorkerOptions = ...
  -
  Options for the worker.
  -
Returns AbstractWorker<MainWorker, Data, Response>

Properties

Protected Optional Readonly aliveInterval

aliveInterval?: Timeout

Handler Id of the aliveInterval worker alive check.

Protected lastTaskTimestamp

lastTaskTimestamp: number

Timestamp of the last task processed by this worker.

Protected mainWorker

mainWorker: undefined | null | MainWorker

Readonly opts

opts: WorkerOptions = ...

Methods

asyncId

asyncId(): number

Inherited from AsyncResource.asyncId
- Defined in node_modules/@types/node/async_hooks.d.ts:315
Returns number
The unique asyncId assigned to the resource.
-

bind

bind<Func>(fn: Func): Func & { asyncResource: AsyncResource }

Inherited from AsyncResource.bind
- Defined in node_modules/@types/node/async_hooks.d.ts:288
-
Binds the given function to execute to this AsyncResource's scope.
-
The returned function will have an asyncResource property referencing -the AsyncResource to which the function is bound.
-
since
v14.8.0, v12.19.0
-
Type parameters
- Func: (...args: any[]) => any
Parameters
- fn: Func
  -
  The function to bind to the current AsyncResource.
  -
Returns Func & { asyncResource: AsyncResource }

Protected checkAlive

checkAlive(): void

- Defined in src/worker/abstract-worker.ts:133
-
Check to see if the worker should be terminated, because its living too long.
-
Returns void

Private checkFunctionInput

checkFunctionInput(fn: (data: Data) => Response): void

- Defined in src/worker/abstract-worker.ts:107
-
Check if the fn parameter is passed to the constructor.
-
Parameters
- fn: (data: Data) => Response
  -
  The function that should be defined.
  -
  - - (data: Data): Response
    - Parameters
      - data: Data
      Returns Response
Returns void

Private checkWorkerOptions

checkWorkerOptions(opts: WorkerOptions): void

- Defined in src/worker/abstract-worker.ts:92
Parameters
- opts: WorkerOptions
Returns void

emitDestroy

emitDestroy(): AbstractWorker<MainWorker, Data, Response>

Inherited from AsyncResource.emitDestroy
- Defined in node_modules/@types/node/async_hooks.d.ts:311
-
Call all destroy hooks. This should only ever be called once. An error will -be thrown if it is called more than once. This must be manually called. If -the resource is left to be collected by the GC then the destroy hooks will -never be called.
-
Returns AbstractWorker<MainWorker, Data, Response>
A reference to asyncResource.
-

Protected getMainWorker

getMainWorker(): MainWorker

- Defined in src/worker/abstract-worker.ts:116
-
Returns the main worker.
-
Returns MainWorker
Reference to the main worker.
-

Protected handleError

handleError(e: string | Error): string

- Defined in src/worker/abstract-worker.ts:148
-
Handle an error and convert it to a string so it can be sent back to the main worker.
-
Parameters
- e: string | Error
  -
  The error raised by the worker.
  -
Returns string
Message of the error.
-

Protected run

run(fn: (data?: Data) => Response, value: MessageValue<Data, unknown>): void

- Defined in src/worker/abstract-worker.ts:158
-
Run the given function synchronously.
-
Parameters
- fn: (data?: Data) => Response
  -
  Function that will be executed.
  -
  - - (data?: Data): Response
    - Parameters
      - Optional data: Data
      Returns Response
- value: MessageValue<Data, unknown>
  -
  Input data for the given function.
  -
Returns void

Protected runAsync

runAsync(fn: (data?: Data) => Promise<Response>, value: MessageValue<Data, unknown>): void

- Defined in src/worker/abstract-worker.ts:179
-
Run the given function asynchronously.
-
Parameters
- fn: (data?: Data) => Promise<Response>
  -
  Function that will be executed.
  -
  - - (data?: Data): Promise<Response>
    - Parameters
      - Optional data: Data
      Returns Promise<Response>
- value: MessageValue<Data, unknown>
  -
  Input data for the given function.
  -
Returns void

runInAsyncScope

runInAsyncScope<This, Result>(fn: (...args: any[]) => Result, thisArg?: This, ...args: any[]): Result

Inherited from AsyncResource.runInAsyncScope
- Defined in node_modules/@types/node/async_hooks.d.ts:303
-
Call the provided function with the provided arguments in the execution context -of the async resource. This will establish the context, trigger the AsyncHooks -before callbacks, call the function, trigger the AsyncHooks after callbacks, and -then restore the original execution context.
-
since
v9.6.0
-
Type parameters
- This
- Result
Parameters
- fn: (...args: any[]) => Result
  -
  The function to call in the execution context of this async resource.
  -
  - - (...args: any[]): Result
    - Parameters
      - Rest ...args: any[]
      Returns Result
- Optional thisArg: This
  -
  The receiver to be used for the function call.
  -
- Rest ...args: any[]
  -
  Optional arguments to pass to the function.
  -
Returns Result

Protected Abstract sendToMainWorker

sendToMainWorker(message: MessageValue<Response, unknown>): void

- Defined in src/worker/abstract-worker.ts:128
-
Send a message to the main worker.
-
Parameters
- message: MessageValue<Response, unknown>
  -
  The response message.
  -
Returns void

triggerAsyncId

triggerAsyncId(): number

Inherited from AsyncResource.triggerAsyncId
- Defined in node_modules/@types/node/async_hooks.d.ts:320
Returns number
The same triggerAsyncId that is passed to the AsyncResource constructor.
-

Static bind

bind<Func, ThisArg>(fn: Func, type?: string, thisArg?: ThisArg): Func & { asyncResource: AsyncResource }

Inherited from AsyncResource.bind
- Defined in node_modules/@types/node/async_hooks.d.ts:273
-
Binds the given function to the current execution context.
-
The returned function will have an asyncResource property referencing -the AsyncResource to which the function is bound.
-
since
v14.8.0, v12.19.0
-
Type parameters
- Func: (...args: any[]) => any
- ThisArg
Parameters
- fn: Func
  -
  The function to bind to the current execution context.
  -
- Optional type: string
  -
  An optional name to associate with the underlying AsyncResource.
  -
- Optional thisArg: ThisArg
Returns Func & { asyncResource: AsyncResource }

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

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

`Private` beginTaskPerformance

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

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

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

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

`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: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.
+
- 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
- Defined in src/worker/abstract-worker.ts:374

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

`Protected` handleTaskFunctionOperationMessage

handleTaskFunctionOperationMessage(message): void
Parameters
- message: MessageValue<Data, unknown>
Returns void
- 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.
+
- 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.
+
- 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
- Defined in src/worker/abstract-worker.ts:304

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

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

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

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

`Protected` sendTaskFunctionNamesToMainWorker

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

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

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

`Private` startCheckActive

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

`Private` stopCheckActive

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

`Private` updateLastTaskTimestamp

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

Type parameters

MainWorker: Worker | MessagePort

Data = unknown

Response = unknown

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

MainWorker: Worker | MessagePort

Data = unknown

Response = unknown

Parameters

type: string

isMain: boolean

fn: (data: Data) => Response

Parameters

data: Data

Returns Response

mainWorker: undefined | null | MainWorker

opts: WorkerOptions = ...

Returns AbstractWorker<MainWorker, Data, Response>

Properties

Protected Optional Readonly aliveInterval

Protected lastTaskTimestamp

Protected mainWorker

Readonly opts

Methods

asyncId

Returns number

bind

Type parameters

Func: (...args: any[]) => any

Parameters

fn: Func

Returns Func & { asyncResource: AsyncResource }

Protected checkAlive

Returns void

Private checkFunctionInput

Parameters

fn: (data: Data) => Response

Parameters

data: Data

Returns Response

Returns void

Private checkWorkerOptions

Parameters

opts: WorkerOptions

Returns void

emitDestroy

Returns AbstractWorker<MainWorker, Data, Response>

Protected getMainWorker

Returns MainWorker

Protected handleError

Parameters

e: string | Error

Returns string

Protected run

Parameters

fn: (data?: Data) => Response

Parameters

Optional data: Data

Returns Response

value: MessageValue<Data, unknown>

Returns void

Protected runAsync

Parameters

fn: (data?: Data) => Promise<Response>

Parameters

Optional data: Data

Returns Promise<Response>

value: MessageValue<Data, unknown>

Returns void

runInAsyncScope

Type parameters

This

Result

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