A thread worker used by a poolifier ThreadPool.

When this worker is inactive for more than the given maxInactiveTime, +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, but the minimum number of workers will be guaranteed.

template DataType: of data this worker receives from pool's execution. This can only be serializable data.
-
template ResponseType: of response the worker sends back to the main thread. This can only be serializable data.
-
author: Alessandro Pio Ardizio
-
since: 0.0.1
-

Type parameters

Data = unknown
Response = unknown

Hierarchy

AbstractWorker<MessagePort, Data, Response>
- ThreadWorker

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ThreadWorker<Data, Response>(fn: (data: Data) => Response, opts?: WorkerOptions): ThreadWorker<Data, Response>

Overrides AbstractWorker.constructor
- Defined in src/worker/thread-worker.ts:31
-
Constructs a new poolifier thread worker.
-
Type parameters
- Data = unknown
- Response = unknown
Parameters
- 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
- opts: WorkerOptions = {}
  -
  Options for the worker.
  -
Returns ThreadWorker<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 | MessagePort

Readonly opts

opts: WorkerOptions = ...

Methods

asyncId

asyncId(): number

Inherited from AbstractWorker.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 AbstractWorker.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

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

emitDestroy

emitDestroy(): ThreadWorker<Data, Response>

Inherited from AbstractWorker.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 ThreadWorker<Data, Response>
A reference to asyncResource.
-

Protected getMainWorker

getMainWorker(): MessagePort

Inherited from AbstractWorker.getMainWorker
- Defined in src/worker/abstract-worker.ts:116
-
Returns the main worker.
-
Returns MessagePort
Reference to the main worker.
-

Protected handleError

handleError(e: string | Error): string

Inherited from AbstractWorker.handleError
- 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

Inherited from AbstractWorker.run
- 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

Inherited from AbstractWorker.runAsync
- 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 AbstractWorker.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 sendToMainWorker

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

Overrides AbstractWorker.sendToMainWorker
- Defined in src/worker/thread-worker.ts:36
-
Send a message to the main worker.
-
Parameters
- message: MessageValue<Response, unknown>
  -
  The response message.
  -
Returns void

triggerAsyncId

triggerAsyncId(): number

Inherited from AbstractWorker.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 AbstractWorker.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 }

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(): 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: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: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:49

`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.
+
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.
+
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.
+
Parameters
- name: string
  The name of the task function to remove.
  +
Returns TaskFunctionOperationResult
Whether the task function existed and was removed or not.
+
Inherited from AbstractWorker.removeTaskFunction
- 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
Inherited from AbstractWorker.run
- 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
Inherited from AbstractWorker.runAsync
- 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
Inherited from AbstractWorker.runSync
- Defined in src/worker/abstract-worker.ts:520

`Protected` sendTaskFunctionNamesToMainWorker

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

`Protected` `Readonly` sendToMainWorker

sendToMainWorker(message): void
Sends a message to main worker.
+
Parameters
- message: MessageValue<Response, unknown>
  The response message.
  +
Returns void
Overrides AbstractWorker.sendToMainWorker
- Defined in src/worker/thread-worker.ts:84

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

Class ThreadWorker<Data, Response>

Type parameters

Data = unknown

Response = unknown

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

Data = unknown

Response = unknown

Parameters

fn: (data: Data) => Response

Parameters

data: Data

Returns Response

opts: WorkerOptions = {}

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

emitDestroy

Returns ThreadWorker<Data, Response>

Protected getMainWorker

Returns MessagePort

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

Parameters

fn: (...args: any[]) => Result

Parameters

Rest ...args: any[]

Returns Result

Optional thisArg: This

Rest ...args: any[]

Returns Result

Protected sendToMainWorker

Parameters

message: MessageValue<Response, unknown>

Returns void

triggerAsyncId

Returns number

Static bind

`Protected` `Optional` activeInterval

`Protected` `Readonly` isMain

`Protected` lastTaskTimestamp

`Protected` opts

`Private` `Optional` port

`Protected` `Optional` statistics

`Protected` taskFunctions

`Protected` id

`Protected` getMainWorker

`Protected` handleError

`Protected` handleKillMessage

`Protected` handleReadyMessage

`Protected` handleTaskFunctionOperationMessage