X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fcluster%2Ffixed.ts;h=d644f2298000fe1b6176f335ff228e51483e9144;hb=0770fe626b2bb3212a1d73fa4764973ac92e241a;hp=9844c4a8a912570c10043e4980b8bb3113aab6f1;hpb=7e0d447f83e76296d95fc71dcdcfbe6fa2fe1f26;p=poolifier.git diff --git a/src/pools/cluster/fixed.ts b/src/pools/cluster/fixed.ts index 9844c4a8..d644f229 100644 --- a/src/pools/cluster/fixed.ts +++ b/src/pools/cluster/fixed.ts @@ -1,7 +1,8 @@ -import cluster, { 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-internal' /** @@ -15,6 +16,12 @@ export interface ClusterPoolOptions extends PoolOptions { */ // 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 } /** @@ -24,8 +31,8 @@ export interface ClusterPoolOptions extends PoolOptions { * * This pool selects the workers in a round robin fashion. * - * @template DataType of data sent to the worker. This can only be serializable data. - * @template ResponseType 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 response of execution. This can only be serializable data. * @author [Christopher Quadflieg](https://github.com/Shinigami92) * @since 2.0.0 */ @@ -36,9 +43,9 @@ export class FixedClusterPool< /** * 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. + * @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, @@ -48,55 +55,58 @@ export class FixedClusterPool< super(numberOfWorkers, filePath, opts) } - /** @inheritdoc */ + /** {@inheritDoc} */ protected setupHook (): void { - cluster.setupPrimary({ - exec: this.filePath - }) + cluster.setupPrimary({ ...this.opts.settings, exec: this.filePath }) } - /** @inheritdoc */ + /** {@inheritDoc} */ protected isMain (): boolean { return cluster.isPrimary } - /** @inheritdoc */ + /** {@inheritDoc} */ public destroyWorker (worker: Worker): void { this.sendToWorker(worker, { kill: 1 }) worker.kill() } - /** @inheritdoc */ + /** {@inheritDoc} */ protected sendToWorker (worker: Worker, message: MessageValue): void { worker.send(message) } - /** @inheritdoc */ - public registerWorkerMessageListener ( + /** {@inheritDoc} */ + public registerWorkerMessageListener( worker: Worker, listener: (message: MessageValue) => void ): void { worker.on('message', listener) } - /** @inheritdoc */ + /** {@inheritDoc} */ protected createWorker (): Worker { return cluster.fork(this.opts.env) } - /** @inheritdoc */ + /** {@inheritDoc} */ protected afterWorkerSetup (worker: Worker): void { - // Listen worker messages. + // Listen to worker messages. this.registerWorkerMessageListener(worker, super.workerListener()) } - /** @inheritdoc */ + /** {@inheritDoc} */ public get type (): PoolType { return PoolType.FIXED } - /** @inheritdoc */ + /** {@inheritDoc} */ + public get full (): boolean { + return this.workers.length === this.numberOfWorkers + } + + /** {@inheritDoc} */ public get busy (): boolean { - return this.internalGetBusyStatus() + return this.internalBusy() } }