1 import type { ClusterSettings
, Worker
} from
'cluster'
2 import cluster from
'cluster'
3 import type { MessageValue
} from
'../../utility-types'
4 import { EMPTY_OBJECT_LITERAL
} from
'../../utils'
5 import { AbstractPool
} from
'../abstract-pool'
6 import type { PoolOptions
} from
'../pool'
7 import { PoolType
} from
'../pool-internal'
10 * Options for a poolifier cluster pool.
12 export interface ClusterPoolOptions
extends PoolOptions
<Worker
> {
14 * Key/value pairs to add to worker process environment.
16 * @see https://nodejs.org/api/cluster.html#cluster_cluster_fork_env
18 // eslint-disable-next-line @typescript-eslint/no-explicit-any
23 * @see https://nodejs.org/api/cluster.html#cluster_cluster_settings
25 settings
?: ClusterSettings
29 * A cluster pool with a fixed number of workers.
31 * It is possible to perform tasks in sync or asynchronous mode as you prefer.
33 * This pool selects the workers in a round robin fashion.
35 * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
36 * @typeParam Response - Type of response of execution. This can only be serializable data.
37 * @author [Christopher Quadflieg](https://github.com/Shinigami92)
40 export class FixedClusterPool
<
43 > extends AbstractPool
<Worker
, Data
, Response
> {
45 * Constructs a new poolifier fixed cluster pool.
47 * @param numberOfWorkers - Number of workers for this pool.
48 * @param filePath - Path to an implementation of a `ClusterWorker` file, which can be relative or absolute.
49 * @param opts - Options for this fixed cluster pool.
52 numberOfWorkers
: number,
54 public readonly opts
: ClusterPoolOptions
= EMPTY_OBJECT_LITERAL
56 super(numberOfWorkers
, filePath
, opts
)
60 protected setupHook (): void {
61 cluster
.setupPrimary({ ...this.opts
.settings
, exec
: this.filePath
})
65 protected isMain (): boolean {
66 return cluster
.isPrimary
70 public destroyWorker (worker
: Worker
): void {
71 this.sendToWorker(worker
, { kill
: 1 })
76 protected sendToWorker (worker
: Worker
, message
: MessageValue
<Data
>): void {
81 public registerWorkerMessageListener
<Message
extends Data
| Response
>(
83 listener
: (message
: MessageValue
<Message
>) => void
85 worker
.on('message', listener
)
89 protected createWorker (): Worker
{
90 return cluster
.fork(this.opts
.env
)
94 protected afterWorkerSetup (worker
: Worker
): void {
95 // Listen to worker messages.
96 this.registerWorkerMessageListener(worker
, super.workerListener())
100 public get
type (): PoolType
{
101 return PoolType
.FIXED
105 public get
busy (): boolean {
106 return this.internalGetBusyStatus()