Commit | Line | Data |
---|---|---|
c3719753 | 1 | import cluster, { type Worker } from 'node:cluster' |
d35e5717 JB |
2 | import type { MessageValue } from '../../utility-types.js' |
3 | import { AbstractPool } from '../abstract-pool.js' | |
4 | import { type PoolOptions, type PoolType, PoolTypes } from '../pool.js' | |
5 | import { type WorkerType, WorkerTypes } from '../worker.js' | |
4ade5f1f | 6 | |
2889bd70 JB |
7 | /** |
8 | * Options for a poolifier cluster pool. | |
9 | */ | |
10 | export type ClusterPoolOptions = PoolOptions<Worker> | |
11 | ||
4ade5f1f | 12 | /** |
729c563d S |
13 | * A cluster pool with a fixed number of workers. |
14 | * | |
e102732c JB |
15 | * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. |
16 | * @typeParam Response - Type of execution response. This can only be structured-cloneable data. | |
325f50bc S |
17 | * @author [Christopher Quadflieg](https://github.com/Shinigami92) |
18 | * @since 2.0.0 | |
4ade5f1f | 19 | */ |
d3c8a1a8 | 20 | export class FixedClusterPool< |
deb85c12 JB |
21 | Data = unknown, |
22 | Response = unknown | |
d3c8a1a8 | 23 | > extends AbstractPool<Worker, Data, Response> { |
4ade5f1f | 24 | /** |
729c563d S |
25 | * Constructs a new poolifier fixed cluster pool. |
26 | * | |
38e795c1 JB |
27 | * @param numberOfWorkers - Number of workers for this pool. |
28 | * @param filePath - Path to an implementation of a `ClusterWorker` file, which can be relative or absolute. | |
29 | * @param opts - Options for this fixed cluster pool. | |
4ade5f1f S |
30 | */ |
31 | public constructor ( | |
5c5a1fb7 | 32 | numberOfWorkers: number, |
c97c7edb | 33 | filePath: string, |
2889bd70 | 34 | opts: ClusterPoolOptions = {}, |
26ce26ca | 35 | maximumNumberOfWorkers?: number |
4ade5f1f | 36 | ) { |
26ce26ca | 37 | super(numberOfWorkers, filePath, opts, maximumNumberOfWorkers) |
c97c7edb | 38 | } |
4ade5f1f | 39 | |
afc003b2 | 40 | /** @inheritDoc */ |
c97c7edb | 41 | protected setupHook (): void { |
1a76932b | 42 | cluster.setupPrimary({ ...this.opts.settings, exec: this.filePath }) |
c97c7edb | 43 | } |
325f50bc | 44 | |
afc003b2 | 45 | /** @inheritDoc */ |
c97c7edb | 46 | protected isMain (): boolean { |
7e0d447f | 47 | return cluster.isPrimary |
4ade5f1f S |
48 | } |
49 | ||
afc003b2 | 50 | /** @inheritDoc */ |
aa9eede8 JB |
51 | protected sendToWorker ( |
52 | workerNodeKey: number, | |
53 | message: MessageValue<Data> | |
54 | ): void { | |
72ae84a2 JB |
55 | this.workerNodes[workerNodeKey].worker.send({ |
56 | ...message, | |
67f3f2d6 JB |
57 | // eslint-disable-next-line @typescript-eslint/no-non-null-assertion |
58 | workerId: this.getWorkerInfo(workerNodeKey).id! | |
72ae84a2 | 59 | }) |
4ade5f1f S |
60 | } |
61 | ||
85aeb3f3 | 62 | /** @inheritDoc */ |
aa9eede8 JB |
63 | protected sendStartupMessageToWorker (workerNodeKey: number): void { |
64 | this.sendToWorker(workerNodeKey, { | |
e9dd5b66 | 65 | ready: false |
85aeb3f3 JB |
66 | }) |
67 | } | |
68 | ||
69 | /** @inheritDoc */ | |
70 | protected registerWorkerMessageListener<Message extends Data | Response>( | |
aa9eede8 | 71 | workerNodeKey: number, |
85aeb3f3 JB |
72 | listener: (message: MessageValue<Message>) => void |
73 | ): void { | |
aa9eede8 | 74 | this.workerNodes[workerNodeKey].worker.on('message', listener) |
85aeb3f3 JB |
75 | } |
76 | ||
ae036c3e JB |
77 | /** @inheritDoc */ |
78 | protected registerOnceWorkerMessageListener<Message extends Data | Response>( | |
79 | workerNodeKey: number, | |
80 | listener: (message: MessageValue<Message>) => void | |
81 | ): void { | |
82 | this.workerNodes[workerNodeKey].worker.once('message', listener) | |
83 | } | |
84 | ||
85 | /** @inheritDoc */ | |
86 | protected deregisterWorkerMessageListener<Message extends Data | Response>( | |
87 | workerNodeKey: number, | |
88 | listener: (message: MessageValue<Message>) => void | |
89 | ): void { | |
90 | this.workerNodes[workerNodeKey].worker.off('message', listener) | |
91 | } | |
92 | ||
9d9fb7b6 JB |
93 | /** @inheritDoc */ |
94 | protected shallCreateDynamicWorker (): boolean { | |
95 | return false | |
96 | } | |
97 | ||
d0878034 | 98 | /** @inheritDoc */ |
d1c03778 JB |
99 | protected checkAndEmitDynamicWorkerCreationEvents (): void { |
100 | /* noop */ | |
101 | } | |
d0878034 | 102 | |
afc003b2 | 103 | /** @inheritDoc */ |
8881ae32 | 104 | protected get type (): PoolType { |
6b27d407 | 105 | return PoolTypes.fixed |
7c0ba920 JB |
106 | } |
107 | ||
184855e6 JB |
108 | /** @inheritDoc */ |
109 | protected get worker (): WorkerType { | |
110 | return WorkerTypes.cluster | |
111 | } | |
112 | ||
afc003b2 | 113 | /** @inheritDoc */ |
c319c66b | 114 | protected get busy (): boolean { |
c2ade475 | 115 | return this.internalBusy() |
7c0ba920 | 116 | } |
4ade5f1f | 117 | } |