| 1 | import cluster, { type Worker } from 'node:cluster' |
| 2 | import type { MessageValue } from '../../utility-types' |
| 3 | import { AbstractPool } from '../abstract-pool' |
| 4 | import { type PoolOptions, type PoolType, PoolTypes } from '../pool' |
| 5 | import { type WorkerType, WorkerTypes } from '../worker' |
| 6 | |
| 7 | /** |
| 8 | * A cluster pool with a fixed number of workers. |
| 9 | * |
| 10 | * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. |
| 11 | * @typeParam Response - Type of execution response. This can only be structured-cloneable data. |
| 12 | * @author [Christopher Quadflieg](https://github.com/Shinigami92) |
| 13 | * @since 2.0.0 |
| 14 | */ |
| 15 | export class FixedClusterPool< |
| 16 | Data = unknown, |
| 17 | Response = unknown |
| 18 | > extends AbstractPool<Worker, Data, Response> { |
| 19 | /** |
| 20 | * Constructs a new poolifier fixed cluster pool. |
| 21 | * |
| 22 | * @param numberOfWorkers - Number of workers for this pool. |
| 23 | * @param filePath - Path to an implementation of a `ClusterWorker` file, which can be relative or absolute. |
| 24 | * @param opts - Options for this fixed cluster pool. |
| 25 | */ |
| 26 | public constructor ( |
| 27 | numberOfWorkers: number, |
| 28 | filePath: string, |
| 29 | protected readonly opts: PoolOptions<Worker> = {} |
| 30 | ) { |
| 31 | super(numberOfWorkers, filePath, opts) |
| 32 | } |
| 33 | |
| 34 | /** @inheritDoc */ |
| 35 | protected setupHook (): void { |
| 36 | cluster.setupPrimary({ ...this.opts.settings, exec: this.filePath }) |
| 37 | } |
| 38 | |
| 39 | /** @inheritDoc */ |
| 40 | protected isMain (): boolean { |
| 41 | return cluster.isPrimary |
| 42 | } |
| 43 | |
| 44 | /** @inheritDoc */ |
| 45 | protected sendToWorker ( |
| 46 | workerNodeKey: number, |
| 47 | message: MessageValue<Data> |
| 48 | ): void { |
| 49 | this.workerNodes[workerNodeKey].worker.send({ |
| 50 | ...message, |
| 51 | workerId: this.getWorkerInfo(workerNodeKey).id as number |
| 52 | }) |
| 53 | } |
| 54 | |
| 55 | /** @inheritDoc */ |
| 56 | protected sendStartupMessageToWorker (workerNodeKey: number): void { |
| 57 | this.sendToWorker(workerNodeKey, { |
| 58 | ready: false |
| 59 | }) |
| 60 | } |
| 61 | |
| 62 | /** @inheritDoc */ |
| 63 | protected registerWorkerMessageListener<Message extends Data | Response>( |
| 64 | workerNodeKey: number, |
| 65 | listener: (message: MessageValue<Message>) => void |
| 66 | ): void { |
| 67 | this.workerNodes[workerNodeKey].worker.on('message', listener) |
| 68 | } |
| 69 | |
| 70 | /** @inheritDoc */ |
| 71 | protected registerOnceWorkerMessageListener<Message extends Data | Response>( |
| 72 | workerNodeKey: number, |
| 73 | listener: (message: MessageValue<Message>) => void |
| 74 | ): void { |
| 75 | this.workerNodes[workerNodeKey].worker.once('message', listener) |
| 76 | } |
| 77 | |
| 78 | /** @inheritDoc */ |
| 79 | protected deregisterWorkerMessageListener<Message extends Data | Response>( |
| 80 | workerNodeKey: number, |
| 81 | listener: (message: MessageValue<Message>) => void |
| 82 | ): void { |
| 83 | this.workerNodes[workerNodeKey].worker.off('message', listener) |
| 84 | } |
| 85 | |
| 86 | /** @inheritDoc */ |
| 87 | protected get type (): PoolType { |
| 88 | return PoolTypes.fixed |
| 89 | } |
| 90 | |
| 91 | /** @inheritDoc */ |
| 92 | protected get worker (): WorkerType { |
| 93 | return WorkerTypes.cluster |
| 94 | } |
| 95 | |
| 96 | /** @inheritDoc */ |
| 97 | protected get busy (): boolean { |
| 98 | return this.internalBusy() |
| 99 | } |
| 100 | } |