Commit | Line | Data |
---|---|---|
325f50bc | 1 | import { fork, isMaster, setupMaster, Worker } from 'cluster' |
deb85c12 | 2 | import type { MessageValue } from '../../utility-types' |
c97c7edb S |
3 | import type { PoolOptions } from '../abstract-pool' |
4 | import { AbstractPool } from '../abstract-pool' | |
7c0ba920 | 5 | import { PoolType } from '../pool-internal' |
4ade5f1f | 6 | |
729c563d S |
7 | /** |
8 | * Options for a poolifier cluster pool. | |
9 | */ | |
c97c7edb | 10 | export interface ClusterPoolOptions extends PoolOptions<Worker> { |
325f50bc S |
11 | /** |
12 | * Key/value pairs to add to worker process environment. | |
13 | * | |
14 | * @see https://nodejs.org/api/cluster.html#cluster_cluster_fork_env | |
15 | */ | |
16 | // eslint-disable-next-line @typescript-eslint/no-explicit-any | |
17 | env?: any | |
4ade5f1f S |
18 | } |
19 | ||
20 | /** | |
729c563d S |
21 | * A cluster pool with a fixed number of workers. |
22 | * | |
23 | * It is possible to perform tasks in sync or asynchronous mode as you prefer. | |
4ade5f1f | 24 | * |
729c563d S |
25 | * This pool selects the workers in a round robin fashion. |
26 | * | |
deb85c12 JB |
27 | * @template Data Type of data sent to the worker. This can only be serializable data. |
28 | * @template Response Type of response of execution. This can only be serializable data. | |
4ade5f1f | 29 | * |
325f50bc S |
30 | * @author [Christopher Quadflieg](https://github.com/Shinigami92) |
31 | * @since 2.0.0 | |
4ade5f1f | 32 | */ |
d3c8a1a8 | 33 | export class FixedClusterPool< |
deb85c12 JB |
34 | Data = unknown, |
35 | Response = unknown | |
d3c8a1a8 | 36 | > extends AbstractPool<Worker, Data, Response> { |
4ade5f1f | 37 | /** |
729c563d S |
38 | * Constructs a new poolifier fixed cluster pool. |
39 | * | |
5c5a1fb7 | 40 | * @param numberOfWorkers Number of workers for this pool. |
729c563d | 41 | * @param filePath Path to an implementation of a `ClusterWorker` file, which can be relative or absolute. |
1927ee67 | 42 | * @param opts Options for this fixed cluster pool. Default: `{}` |
4ade5f1f S |
43 | */ |
44 | public constructor ( | |
5c5a1fb7 | 45 | numberOfWorkers: number, |
c97c7edb | 46 | filePath: string, |
1927ee67 | 47 | public readonly opts: ClusterPoolOptions = {} |
4ade5f1f | 48 | ) { |
5c5a1fb7 | 49 | super(numberOfWorkers, filePath, opts) |
c97c7edb | 50 | } |
4ade5f1f | 51 | |
6e9d10db | 52 | /** @inheritdoc */ |
c97c7edb | 53 | protected setupHook (): void { |
325f50bc S |
54 | setupMaster({ |
55 | exec: this.filePath | |
56 | }) | |
c97c7edb | 57 | } |
325f50bc | 58 | |
6e9d10db | 59 | /** @inheritdoc */ |
c97c7edb S |
60 | protected isMain (): boolean { |
61 | return isMaster | |
4ade5f1f S |
62 | } |
63 | ||
a35560ba S |
64 | /** @inheritdoc */ |
65 | public destroyWorker (worker: Worker): void { | |
cefac5ba | 66 | this.sendToWorker(worker, { kill: 1 }) |
c97c7edb | 67 | worker.kill() |
4ade5f1f S |
68 | } |
69 | ||
6e9d10db | 70 | /** @inheritdoc */ |
c97c7edb S |
71 | protected sendToWorker (worker: Worker, message: MessageValue<Data>): void { |
72 | worker.send(message) | |
4ade5f1f S |
73 | } |
74 | ||
a35560ba S |
75 | /** @inheritdoc */ |
76 | public registerWorkerMessageListener<Message extends Data | Response> ( | |
4f7fa42a S |
77 | worker: Worker, |
78 | listener: (message: MessageValue<Message>) => void | |
c97c7edb | 79 | ): void { |
4f7fa42a | 80 | worker.on('message', listener) |
c97c7edb S |
81 | } |
82 | ||
6e9d10db | 83 | /** @inheritdoc */ |
280c2a77 | 84 | protected createWorker (): Worker { |
c97c7edb | 85 | return fork(this.opts.env) |
4ade5f1f S |
86 | } |
87 | ||
6e9d10db | 88 | /** @inheritdoc */ |
280c2a77 | 89 | protected afterWorkerSetup (worker: Worker): void { |
1927ee67 | 90 | // Listen worker messages. |
be0676b3 | 91 | this.registerWorkerMessageListener(worker, super.workerListener()) |
4ade5f1f | 92 | } |
7c0ba920 JB |
93 | |
94 | /** @inheritdoc */ | |
95 | public get type (): PoolType { | |
96 | return PoolType.FIXED | |
97 | } | |
98 | ||
99 | /** @inheritdoc */ | |
100 | public get busy (): boolean { | |
101 | return this.internalGetBusyStatus() | |
102 | } | |
4ade5f1f | 103 | } |