-import cluster, { type ClusterSettings, type Worker } from 'node:cluster'
-import type { MessageValue } from '../../utility-types'
-import { AbstractPool } from '../abstract-pool'
-import {
- type PoolOptions,
- type PoolType,
- PoolTypes,
- type WorkerType,
- WorkerTypes
-} from '../pool'
+import cluster, { type Worker } from 'node:cluster'
+
+import type { MessageValue } from '../../utility-types.js'
+import { AbstractPool } from '../abstract-pool.js'
+import { type PoolOptions, type PoolType, PoolTypes } from '../pool.js'
+import { type WorkerType, WorkerTypes } from '../worker.js'
/**
* Options for a poolifier cluster pool.
*/
-export interface ClusterPoolOptions extends PoolOptions<Worker> {
- /**
- * Key/value pairs to add to worker process environment.
- *
- * @see https://nodejs.org/api/cluster.html#cluster_cluster_fork_env
- */
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- env?: any
- /**
- * Cluster settings.
- *
- * @see https://nodejs.org/api/cluster.html#cluster_cluster_settings
- */
- settings?: ClusterSettings
-}
+export type ClusterPoolOptions = PoolOptions<Worker>
/**
* A cluster pool with a fixed number of workers.
*
- * It is possible to perform tasks in sync or asynchronous mode as you prefer.
- *
- * This pool selects the workers in a round robin fashion.
- *
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of execution response. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
* @author [Christopher Quadflieg](https://github.com/Shinigami92)
* @since 2.0.0
*/
public constructor (
numberOfWorkers: number,
filePath: string,
- public readonly opts: ClusterPoolOptions = {}
+ opts: ClusterPoolOptions = {},
+ maximumNumberOfWorkers?: number
) {
- super(numberOfWorkers, filePath, opts)
+ super(numberOfWorkers, filePath, opts, maximumNumberOfWorkers)
}
/** @inheritDoc */
}
/** @inheritDoc */
- protected destroyWorker (worker: Worker): void {
- this.sendToWorker(worker, { kill: 1 })
- worker.kill()
+ protected sendToWorker (
+ workerNodeKey: number,
+ message: MessageValue<Data>
+ ): void {
+ this.workerNodes[workerNodeKey]?.worker.send({
+ ...message,
+ workerId: this.getWorkerInfo(workerNodeKey)?.id
+ } satisfies MessageValue<Data>)
}
/** @inheritDoc */
- protected sendToWorker (worker: Worker, message: MessageValue<Data>): void {
- worker.send(message)
+ protected sendStartupMessageToWorker (workerNodeKey: number): void {
+ this.sendToWorker(workerNodeKey, {
+ ready: false
+ })
}
/** @inheritDoc */
protected registerWorkerMessageListener<Message extends Data | Response>(
- worker: Worker,
+ workerNodeKey: number,
listener: (message: MessageValue<Message>) => void
): void {
- worker.on('message', listener)
- }
-
- /** @inheritDoc */
- protected createWorker (): Worker {
- return cluster.fork(this.opts.env)
+ this.workerNodes[workerNodeKey].worker.on('message', listener)
}
/** @inheritDoc */
- protected afterWorkerSetup (worker: Worker): void {
- // Listen to worker messages.
- this.registerWorkerMessageListener(worker, super.workerListener())
+ protected registerOnceWorkerMessageListener<Message extends Data | Response>(
+ workerNodeKey: number,
+ listener: (message: MessageValue<Message>) => void
+ ): void {
+ this.workerNodes[workerNodeKey].worker.once('message', listener)
}
/** @inheritDoc */
- public get type (): PoolType {
- return PoolTypes.fixed
+ protected deregisterWorkerMessageListener<Message extends Data | Response>(
+ workerNodeKey: number,
+ listener: (message: MessageValue<Message>) => void
+ ): void {
+ this.workerNodes[workerNodeKey].worker.off('message', listener)
}
/** @inheritDoc */
- protected get worker (): WorkerType {
- return WorkerTypes.cluster
+ protected shallCreateDynamicWorker (): boolean {
+ return false
}
/** @inheritDoc */
- protected get minSize (): number {
- return this.numberOfWorkers
+ protected checkAndEmitDynamicWorkerCreationEvents (): void {
+ /* noop */
}
/** @inheritDoc */
- protected get maxSize (): number {
- return this.numberOfWorkers
+ protected get type (): PoolType {
+ return PoolTypes.fixed
}
/** @inheritDoc */
- protected get full (): boolean {
- return this.workerNodes.length >= this.numberOfWorkers
+ protected get worker (): WorkerType {
+ return WorkerTypes.cluster
}
/** @inheritDoc */