AbstractWorker | poolifier

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 +AbstractWorker | poolifier - v2.6.28
+
+
+
+
+
+
+
Preparing search index...
+
The search index is not available
poolifier - v2.6.28
+
+
+
+
+
+
poolifier
+
AbstractWorker
+
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
+
+
AsyncResource +
+
AbstractWorker +
+
ClusterWorker
+
ThreadWorker
+
+
Defined in src/worker/abstract-worker.ts:39
+
+
+
+
Index
+
+
+
Constructors
+
constructor +
+
+
Properties
+
activeInterval? +id +isMain +lastTaskTimestamp +mainWorker +opts +statistics +taskFunctions +
+
+
Methods
+
addTaskFunction +asyncId +beginTaskPerformance +bind +checkActive +checkMessageWorkerId +checkStatistics +checkTaskFunctions +checkWorkerOptions +emitDestroy +endTaskPerformance +getMainWorker +getTaskFunction +handleError +handleKillMessage +handleReadyMessage +hasTaskFunction +listTaskFunctions +messageListener +removeTaskFunction +run +runAsync +runInAsyncScope +runSync +sendTaskFunctionsListToMainWorker +sendToMainWorker +setDefaultTaskFunction +startCheckActive +stopCheckActive +triggerAsyncId +updateLastTaskTimestamp +bind +
+
+
Constructors
+
+
constructor
+
+
new AbstractWorker<MainWorker, Data, Response>(type, isMain, mainWorker, taskFunctions, opts?): AbstractWorker<MainWorker, Data, Response>
+
+
Constructs a new poolifier worker.
+
+
+
Type Parameters
+
+
+
MainWorker extends MessagePort | Worker
+
+
Data = unknown
+
+
Response = unknown
+
+
Parameters
+
+
+
type: string
+
The type of async event.
+
+
+
+
isMain: boolean
+
Whether this is the main worker or not.
+
+
+
+
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 = ...
+
Options for the worker.
+
+
+
Returns AbstractWorker<MainWorker, Data, Response>
+
+
Overrides AsyncResource.constructor
+
+
Defined in src/worker/abstract-worker.ts:73
+
+
Properties
+
+
Protected Optional activeInterval
+
activeInterval?: Timeout
+
Handler id of the activeInterval worker activity check.
+
+
+
+
Defined in src/worker/abstract-worker.ts:63
+
+
Protected Abstract id
+
id: number
+
Worker id.
+
+
+
+
Defined in src/worker/abstract-worker.ts:47
+
+
Protected Readonly isMain
+
isMain: boolean
+
Whether this is the main worker or not.
+
+
+
+
Defined in src/worker/abstract-worker.ts:75
+
+
Protected lastTaskTimestamp
+
lastTaskTimestamp: number
+
Timestamp of the last task processed by this worker.
+
+
+
+
Defined in src/worker/abstract-worker.ts:55
+
+
Private Readonly mainWorker
+
mainWorker: MainWorker
+
Reference to main worker.
+
+
+
+
Defined in src/worker/abstract-worker.ts:76
+
+
Protected Readonly opts
+
opts: WorkerOptions = ...
+
Options for the worker.
+
+
+
+
Defined in src/worker/abstract-worker.ts:78
+
+
Protected statistics
+
statistics: WorkerStatistics
+
Performance statistics computation requirements.
+
+
+
+
Defined in src/worker/abstract-worker.ts:59
+
+
Protected taskFunctions
+
taskFunctions: Map<string, TaskFunction<Data, Response>>
+
Task function(s) processed by the worker when the pool's execution function is invoked.
+
+
+
+
Defined in src/worker/abstract-worker.ts:51
+
+
Methods
+
+
addTaskFunction
+
+
addTaskFunction(name, fn): boolean
+
+
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 boolean
Whether the task function was added or not.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
+ +
Throws
https://nodejs.org/api/errors.html#class-error If the name parameter is the default task function reserved name.
+ +
Throws
https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.
+
+
+
Defined in src/worker/abstract-worker.ts:195
+
+
asyncId
+
+
asyncId(): number
+
+
Returns number
The unique asyncId assigned to the resource.
+ +
+
Inherited from AsyncResource.asyncId
+
+
Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:306
+
+
Private beginTaskPerformance
+
+
beginTaskPerformance(name?): TaskPerformance
+
+
+
Parameters
+
+
+
Optional name: string
+
Returns TaskPerformance
+
+
Defined in src/worker/abstract-worker.ts:569
+
+
bind
+
+
bind<Func>(fn): Func
+
+
Binds the given function to execute to this AsyncResource's scope.
+
+
+
Type Parameters
+
+
+
Func extends ((...args) => any)
+
+
Parameters
+
+
+
fn: Func
+
The function to bind to the current AsyncResource.
+
+
+
Returns Func
+
+
Since
v14.8.0, v12.19.0
+
+
Inherited from AsyncResource.bind
+
+
Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:283
+
+
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:410
+
+
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:376
+
+
Private checkStatistics
+
+
checkStatistics(): void
+
+
Returns void
+
+
Defined in src/worker/abstract-worker.ts:593
+
+
Private checkTaskFunctions
+
+
checkTaskFunctions(taskFunctions): void
+
+
Checks if the taskFunctions parameter is passed to the constructor.
+
+
+
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:102
+
+
emitDestroy
+
+
emitDestroy(): AbstractWorker<MainWorker, Data, Response>
+
+
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 +
+
Returns AbstractWorker<MainWorker, Data, Response>
A reference to asyncResource.
+ +
+
Inherited from AsyncResource.emitDestroy
+
- Defined in node_modules/.pnpm/@types+node@20.5.0/node_modules/@types/node/async_hooks.d.ts:302

`Private` endTaskPerformance

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

`Protected` getMainWorker

getMainWorker(): MainWorker
+
Returns the main worker.
+
+
Returns MainWorker
Reference to the main worker.
+ +
+
- Defined in src/worker/abstract-worker.ts:424

`Private` getTaskFunction

getTaskFunction(name?): TaskFunction<Data, Response>
+
Gets the task function with the given name.
+
+
+
Parameters
+
- +
  Optional name: string
  +
  Name of the task function that will be returned.
  +
  +
+
Returns TaskFunction<Data, Response>
The task function.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-error If the task function is not found.
+
+
- Defined in src/worker/abstract-worker.ts:560

`Protected` handleError

handleError(e): string
+
Handles 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
The error message.
+ +
+
- Defined in src/worker/abstract-worker.ts:456

`Protected` handleKillMessage

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

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

hasTaskFunction

hasTaskFunction(name): boolean
+
Checks if the worker has a task function with the given name.
+
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function to check.
  +
  +
+
Returns boolean
Whether the worker has a task function with the given name or not.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
+
+
- Defined in src/worker/abstract-worker.ts:174

listTaskFunctions

listTaskFunctions(): 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:267

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

removeTaskFunction

removeTaskFunction(name): boolean
+
Removes a task function from the worker.
+
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function to remove.
  +
  +
+
Returns boolean
Whether the task function existed and was removed or not.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
+ +
Throws
https://nodejs.org/api/errors.html#class-error If the name parameter is the default task function reserved name.
+ +
Throws
https://nodejs.org/api/errors.html#class-error If the name parameter is the task function used as default task function.
+
+
- Defined in src/worker/abstract-worker.ts:238

`Protected` run

run(task): void
+
Runs the given task.
+
+
+
Parameters
+
- +
  task: Task<Data>
  +
  The task to execute.
  +
  +
+
Returns void
+
+
Throws
https://nodejs.org/api/errors.html#class-error If the task function is not found.
+
+
- Defined in src/worker/abstract-worker.ts:466

`Protected` 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:518

runInAsyncScope

runInAsyncScope<This, Result>(fn, thisArg?, ...args): Result
+
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 }

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

Class AbstractWorker<MainWorker, Data, Response>Abstract

Type Parameters

MainWorker extends Worker | MessagePort

Data = unknown

Response = unknown

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

MainWorker extends MessagePort | Worker

Data = unknown

Response = unknown

Parameters

type: string

isMain: boolean

mainWorker: MainWorker

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

opts: WorkerOptions = ...

Returns AbstractWorker<MainWorker, Data, Response>

Properties

Protected Optional activeInterval

Protected Abstract id

Protected Readonly isMain

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

`Protected` `Optional` activeInterval

`Protected` `Abstract` id

`Protected` `Readonly` isMain

`Protected` lastTaskTimestamp

`Private` `Readonly` mainWorker

`Protected` `Readonly` opts

`Protected` statistics

`Protected` taskFunctions

`Private` beginTaskPerformance

`Optional` name: string

`Private` checkActive

`Private` checkMessageWorkerId

`Private` checkStatistics

`Private` checkTaskFunctions

`Private` checkWorkerOptions