- -

Class ClusterWorker<Data, Response>

A cluster worker used by a poolifier ClusterPool.

+ClusterWorker | poolifier - v4.0.11

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, but the minimum number of workers will be guaranteed.

Author

Christopher Quadflieg

- +

Author

Christopher Quadflieg

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

AbstractWorker<Worker, Data, Response> -
- ClusterWorker

Index

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

Methods

addTaskFunction

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

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 +

Properties

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

Accessors

id +

Methods

addTaskFunction +getMainWorker +handleError +handleKillMessage +handleReadyMessage +handleTaskFunctionOperationMessage +hasTaskFunction +listTaskFunctionsProperties +messageListener +removeTaskFunction +run +runAsync +runSync +sendTaskFunctionsPropertiesToMainWorker +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: 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:32

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, TaskFunctionObject<Data, Response>>

Task function object(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:58

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

asyncId

asyncId(): number
-
Returns number
The unique asyncId assigned to the resource.
- -
-
Inherited from AbstractWorker.asyncId
-
- Defined in node_modules/.pnpm/@types+node@20.8.3/node_modules/@types/node/async_hooks.d.ts:315

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 AbstractWorker.bind
-
- Defined in node_modules/.pnpm/@types+node@20.8.3/node_modules/@types/node/async_hooks.d.ts:288

emitDestroy

emitDestroy(): ClusterWorker<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 ClusterWorker<Data, Response>
A reference to asyncResource.
- -
-
Inherited from AbstractWorker.emitDestroy
-
- Defined in node_modules/.pnpm/@types+node@20.8.3/node_modules/@types/node/async_hooks.d.ts:311

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

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

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

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

`Protected` handleTaskFunctionOperationMessage

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

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

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

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

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.
-
-
-
Type Parameters
-
- -
  This
- -
  Result
-
-
Parameters
-
- -
  fn: ((this, ...args) => Result)
  -
  The function to call in the execution context of this async resource.
  -
  -
  -
  - -
    - (this, ...args): Result
    - -
      -
      Parameters
      -
      -
      -
      this: This
      -
      -
      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
-
-
Since
v9.6.0
-
-
Inherited from AbstractWorker.runInAsyncScope
-
- Defined in node_modules/.pnpm/@types+node@20.8.3/node_modules/@types/node/async_hooks.d.ts:299

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

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

`Protected` 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/cluster-worker.ts:68

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

triggerAsyncId

triggerAsyncId(): number
-
Returns number
The same triggerAsyncId that is passed to the AsyncResource constructor.
- -
-
Inherited from AbstractWorker.triggerAsyncId
-
- Defined in node_modules/.pnpm/@types+node@20.8.3/node_modules/@types/node/async_hooks.d.ts:319

`Static` bind

bind<Func, ThisArg>(fn, type?, thisArg?): Func
-
Binds the given function to the current execution context.
-
-
-
Type Parameters
-
- -
  Func extends ((this, ...args) => 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
-
-
Since
v14.8.0, v12.19.0
-
-
Inherited from AbstractWorker.bind
-
- Defined in node_modules/.pnpm/@types+node@20.8.3/node_modules/@types/node/async_hooks.d.ts:278

Generated using TypeDoc

\ No newline at end of file +

Parameters

name: string
The name of the task function to add.
+
fn: TaskFunction<Data, Response> | TaskFunctionObject<Data, Response>
The task function to add.
+

Returns TaskFunctionOperationResult

Whether the task function was added or not.

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

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

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

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

`Protected` handleTaskFunctionOperationMessage

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

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

listTaskFunctionsProperties

listTaskFunctionsProperties(): TaskFunctionProperties[]
Lists the properties of the worker's task functions.
+
Returns TaskFunctionProperties[]
The properties of the worker's task functions.
+
Inherited from AbstractWorker.listTaskFunctionsProperties
- Defined in src/worker/abstract-worker.ts:254

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

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

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

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

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

`Protected` sendTaskFunctionsPropertiesToMainWorker

sendTaskFunctionsPropertiesToMainWorker(): void
Sends task functions properties to the main worker.
+
Returns void
Inherited from AbstractWorker.sendTaskFunctionsPropertiesToMainWorker
- Defined in src/worker/abstract-worker.ts:504

`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/cluster-worker.ts:63

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

Class ClusterWorker<Data, Response>

Class ClusterWorker<Data, Response>

Author

Author

Since

Type Parameters

Data = unknown

Response = unknown

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

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 statistics

Protected taskFunctions

Accessors

Protected id

Returns number

Methods

addTaskFunction

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

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

asyncId

Returns number

bind

Type Parameters

Func extends ((...args) => any)

Parameters

fn: Func

Returns Func

Since

emitDestroy

Returns ClusterWorker<Data, Response>

Protected getMainWorker

Returns Worker

Throws

Protected handleError

Parameters

error: string | Error

`Protected` `Optional` activeInterval

`Protected` `Readonly` isMain

`Protected` lastTaskTimestamp

`Protected` opts

`Protected` 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` handleError

`Protected` handleKillMessage

`Protected` handleReadyMessage

`Protected` handleTaskFunctionOperationMessage

`Protected` messageListener

`Protected` run

`Protected` runAsync

`Rest` ...args: any[]

`Optional` thisArg: This

`Rest` ...args: any[]

`Protected` runSync

`Protected` sendTaskFunctionNamesToMainWorker

`Protected` sendToMainWorker

`Static` bind