X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fcluster%2Ffixed.ts;h=b8a73e4b0562fff6fbca6f48cab4b582c3c5a562;hb=d4abc60abeea2538c1452ae6d8bd2463bdacc910;hp=ce5a50a6251f291d2099fc54b7ead9ab602c0dad;hpb=b4904890be69e53510b67172dda7b6bbf50a635a;p=poolifier.git diff --git a/src/pools/cluster/fixed.ts b/src/pools/cluster/fixed.ts index ce5a50a6..b8a73e4b 100644 --- a/src/pools/cluster/fixed.ts +++ b/src/pools/cluster/fixed.ts @@ -1,5 +1,5 @@ -import type { ClusterSettings, Worker } from 'cluster' -import cluster from 'cluster' +import type { ClusterSettings, Worker } from 'node:cluster' +import cluster from 'node:cluster' import type { MessageValue } from '../../utility-types' import { AbstractPool } from '../abstract-pool' import type { PoolOptions } from '../pool' @@ -31,8 +31,8 @@ export interface ClusterPoolOptions extends PoolOptions { * * 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 response of execution. This can only be serializable data. * @author [Christopher Quadflieg](https://github.com/Shinigami92) * @since 2.0.0 */ @@ -43,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, @@ -55,52 +55,52 @@ export class FixedClusterPool< super(numberOfWorkers, filePath, opts) } - /** @inheritDoc */ + /** {@inheritDoc} */ protected setupHook (): void { 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 to worker messages. this.registerWorkerMessageListener(worker, super.workerListener()) } - /** @inheritDoc */ + /** {@inheritDoc} */ public get type (): PoolType { return PoolType.FIXED } - /** @inheritDoc */ + /** {@inheritDoc} */ public get busy (): boolean { return this.internalGetBusyStatus() }