-import { fork, isMaster, setupMaster, Worker } from 'cluster'
+import type { ClusterSettings, Worker } from 'node:cluster'
+import cluster from 'node:cluster'
import type { MessageValue } from '../../utility-types'
-import type { PoolOptions } from '../abstract-pool'
import { AbstractPool } from '../abstract-pool'
+import type { PoolOptions } from '../pool'
+import { PoolType } from '../pool'
/**
* Options for a poolifier cluster pool.
*/
// 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
}
/**
*
* This pool selects the workers in a round robin fashion.
*
- * @template Data Type of data sent to the worker. This can only be serializable data.
- * @template Response Type of response of execution. This can only be serializable data.
- *
+ * @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.
* @author [Christopher Quadflieg](https://github.com/Shinigami92)
* @since 2.0.0
*/
/**
* Constructs a new poolifier fixed cluster pool.
*
- * @param numberOfWorkers Number of workers for this pool.
- * @param filePath Path to an implementation of a `ClusterWorker` file, which can be relative or absolute.
- * @param opts Options for this fixed cluster pool. Default: `{}`
+ * @param numberOfWorkers - Number of workers for this pool.
+ * @param filePath - Path to an implementation of a `ClusterWorker` file, which can be relative or absolute.
+ * @param opts - Options for this fixed cluster pool.
*/
public constructor (
numberOfWorkers: number,
super(numberOfWorkers, filePath, opts)
}
+ /** @inheritDoc */
protected setupHook (): void {
- setupMaster({
- exec: this.filePath
- })
+ cluster.setupPrimary({ ...this.opts.settings, exec: this.filePath })
}
+ /** @inheritDoc */
protected isMain (): boolean {
- return isMaster
+ return cluster.isPrimary
}
- /** @inheritdoc */
- public destroyWorker (worker: Worker): void {
+ /** @inheritDoc */
+ protected destroyWorker (worker: Worker): void {
this.sendToWorker(worker, { kill: 1 })
worker.kill()
}
+ /** @inheritDoc */
protected sendToWorker (worker: Worker, message: MessageValue<Data>): void {
worker.send(message)
}
- /** @inheritdoc */
- public registerWorkerMessageListener<Message extends Data | Response> (
+ /** @inheritDoc */
+ protected registerWorkerMessageListener<Message extends Data | Response>(
worker: Worker,
listener: (message: MessageValue<Message>) => void
): void {
worker.on('message', listener)
}
+ /** @inheritDoc */
protected createWorker (): Worker {
- return fork(this.opts.env)
+ return cluster.fork(this.opts.env)
}
+ /** @inheritDoc */
protected afterWorkerSetup (worker: Worker): void {
- // Listen worker messages.
+ // Listen to worker messages.
this.registerWorkerMessageListener(worker, super.workerListener())
}
+
+ /** @inheritDoc */
+ public get type (): PoolType {
+ return PoolType.FIXED
+ }
+
+ /** @inheritDoc */
+ public get size (): number {
+ return this.numberOfWorkers
+ }
+
+ /** @inheritDoc */
+ protected get full (): boolean {
+ return this.workerNodes.length === this.numberOfWorkers
+ }
+
+ /** @inheritDoc */
+ protected get busy (): boolean {
+ return this.internalBusy()
+ }
}