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'
8 * A cluster pool with a fixed number of workers.
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)
15 export class FixedClusterPool
<
18 > extends AbstractPool
<Worker
, Data
, Response
> {
20 * Constructs a new poolifier fixed cluster pool.
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.
27 numberOfWorkers
: number,
29 opts
: PoolOptions
<Worker
> = {},
30 maximumNumberOfWorkers
?: number
32 super(numberOfWorkers
, filePath
, opts
, maximumNumberOfWorkers
)
36 protected setupHook (): void {
37 cluster
.setupPrimary({ ...this.opts
.settings
, exec
: this.filePath
})
41 protected isMain (): boolean {
42 return cluster
.isPrimary
46 protected sendToWorker (
47 workerNodeKey
: number,
48 message
: MessageValue
<Data
>
50 this.workerNodes
[workerNodeKey
].worker
.send({
52 workerId
: this.getWorkerInfo(workerNodeKey
).id
as number
57 protected sendStartupMessageToWorker (workerNodeKey
: number): void {
58 this.sendToWorker(workerNodeKey
, {
64 protected registerWorkerMessageListener
<Message
extends Data
| Response
>(
65 workerNodeKey
: number,
66 listener
: (message
: MessageValue
<Message
>) => void
68 this.workerNodes
[workerNodeKey
].worker
.on('message', listener
)
72 protected registerOnceWorkerMessageListener
<Message
extends Data
| Response
>(
73 workerNodeKey
: number,
74 listener
: (message
: MessageValue
<Message
>) => void
76 this.workerNodes
[workerNodeKey
].worker
.once('message', listener
)
80 protected deregisterWorkerMessageListener
<Message
extends Data
| Response
>(
81 workerNodeKey
: number,
82 listener
: (message
: MessageValue
<Message
>) => void
84 this.workerNodes
[workerNodeKey
].worker
.off('message', listener
)
88 protected get
type (): PoolType
{
89 return PoolTypes
.fixed
93 protected get
worker (): WorkerType
{
94 return WorkerTypes
.cluster
98 protected get
busy (): boolean {
99 return this.internalBusy()