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

Since

2.0.0

Type Parameters

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

AbstractWorker<Worker, Data, Response>
- ClusterWorker

Index

Constructors

constructor

new ClusterWorker<Data, Response>(fn: ((data: Data) => Response), opts?: WorkerOptions): ClusterWorker<Data, Response>
Constructs a new poolifier cluster 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 ClusterWorker<Data, Response>
Overrides AbstractWorker<Worker, Data, Response>.constructor
- Defined in src/worker/cluster-worker.ts:31

Properties

`Protected` `Optional` `Readonly` aliveInterval

aliveInterval?: Timeout

Handler id of the aliveInterval worker alive 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` mainWorker

mainWorker: undefined | null | Worker

Reference to main worker.

`Protected` `Readonly` opts

opts: WorkerOptions = ...

Options for the worker.

Methods

asyncId

asyncId(): number
Returns
The unique asyncId assigned to the resource.

Returns number
Inherited from AbstractWorker.asyncId
- Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:315

bind

bind<Func>(fn: Func): Func & {
asyncResource: AsyncResource;
}
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 extends ((...args: any[]) => any)
Parameters
- fn: Func
  
  The function to bind to the current AsyncResource.
Returns Func & {
asyncResource: AsyncResource;
}
Inherited from AbstractWorker.bind
- Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:288

`Protected` checkAlive

checkAlive(): void
Checks if the worker should be terminated, because its living too long.

Returns void
Inherited from AbstractWorker.checkAlive
- Defined in src/worker/abstract-worker.ts:146

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
A reference to asyncResource.

Returns ClusterWorker<Data, Response>
Inherited from AbstractWorker.emitDestroy
- Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:311

`Protected` getMainWorker

getMainWorker(): Worker
Returns the main worker.

Returns
Reference to the main worker.

Returns Worker
Inherited from AbstractWorker.getMainWorker
- Defined in src/worker/abstract-worker.ts:129

`Protected` handleError

handleError(e: string | Error): string
Inherit Doc
Parameters
- e: string | Error
Returns string
Overrides AbstractWorker.handleError
- Defined in src/worker/cluster-worker.ts:47

`Protected` messageListener

messageListener(message: MessageValue<Data, Worker>, fn: ((data: Data) => Response)): void
Worker message listener.
Parameters
- message: MessageValue<Data, Worker>
  
  Message received.
- 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
Returns void
Inherited from AbstractWorker.messageListener
- Defined in src/worker/abstract-worker.ts:84

`Protected` run

run(fn: ((data?: Data) => Response), message: MessageValue<Data, unknown>): void
Runs the given function synchronously.
Parameters
- fn: ((data?: Data) => Response)
  
  Function that will be executed.
  - - (data?: Data): Response
    - Parameters
      
      Optional data: Data
      
      Returns Response
- message: MessageValue<Data, unknown>
  
  Input data for the given function.
Returns void
Inherited from AbstractWorker.run
- Defined in src/worker/abstract-worker.ts:171

`Protected` runAsync

runAsync(fn: ((data?: Data) => Promise<Response>), message: MessageValue<Data, unknown>): void
Runs 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>
- message: MessageValue<Data, unknown>
  
  Input data for the given function.
Returns void
Inherited from AbstractWorker.runAsync
- Defined in src/worker/abstract-worker.ts:198

runInAsyncScope

runInAsyncScope<This, Result>(fn: ((this: This, ...args: any[]) => Result), thisArg?: This, ...args: any[]): 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: ((this: This, ...args: any[]) => Result)
  
  The function to call in the execution context of this async resource.
  - - (this: This, ...args: any[]): 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
Inherited from AbstractWorker.runInAsyncScope
- Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:303

`Protected` sendToMainWorker

sendToMainWorker(message: MessageValue<Response, unknown>): void
Inherit Doc
Parameters
- message: MessageValue<Response, unknown>
Returns void
Overrides AbstractWorker.sendToMainWorker
- Defined in src/worker/cluster-worker.ts:42

triggerAsyncId

triggerAsyncId(): number
Returns
The same triggerAsyncId that is passed to the AsyncResource constructor.

Returns number
Inherited from AbstractWorker.triggerAsyncId
- Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:320

`Static` bind

bind<Func, ThisArg>(fn: Func, type?: string, thisArg?: ThisArg): Func & {
asyncResource: AsyncResource;
}
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 extends ((this: ThisArg, ...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;
}
Inherited from AbstractWorker.bind
- Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:273

Class ClusterWorker<Data, Response>

Author

Since

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

Properties

Protected Optional Readonly aliveInterval

Protected Readonly isMain

Protected lastTaskTimestamp

Protected mainWorker

Protected Readonly opts

Methods

asyncId

Returns

Returns number

bind

Since

Type Parameters

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

Parameters

fn: Func

Returns Func & { asyncResource: AsyncResource; }

Protected checkAlive

Returns void

emitDestroy

Returns

Returns ClusterWorker<Data, Response>

Protected getMainWorker

Returns

Returns Worker

Protected handleError

Inherit Doc

Parameters

e: string | Error

Returns string

Protected messageListener

Parameters

message: MessageValue<Data, Worker>

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

Parameters

data: Data

Returns Response

Returns void

Protected run

Parameters

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

Parameters

Optional data: Data

Returns Response

message: MessageValue<Data, unknown>

Returns void

Protected runAsync

Parameters

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

Parameters

Optional data: Data

Returns Promise<Response>

message: MessageValue<Data, unknown>

Returns void

runInAsyncScope

Since

Type Parameters

`Protected` `Optional` `Readonly` aliveInterval

`Protected` `Readonly` isMain

`Protected` lastTaskTimestamp

`Protected` mainWorker

`Protected` `Readonly` opts

Returns Func & {
asyncResource: AsyncResource;
}

`Protected` checkAlive

`Protected` getMainWorker

`Protected` handleError

`Protected` messageListener

`Protected` run

`Optional` data: Data

`Protected` runAsync

`Optional` data: Data

`Rest` ...args: any[]

`Optional` thisArg: This

`Rest` ...args: any[]

`Protected` sendToMainWorker

`Static` bind

`Optional` type: string

`Optional` thisArg: ThisArg

Returns Func & {
asyncResource: AsyncResource;
}