Commit | Line | Data |
---|---|---|
6677a3d3 | 1 | import cluster, { type Worker } from 'node:cluster' |
b6b32453 | 2 | import type { MessageValue } from '../utility-types' |
c97c7edb | 3 | import { AbstractWorker } from './abstract-worker' |
325f50bc | 4 | import type { WorkerOptions } from './worker-options' |
82ea6492 | 5 | import type { TaskFunction, TaskFunctions } from './task-functions' |
325f50bc S |
6 | |
7 | /** | |
729c563d | 8 | * A cluster worker used by a poolifier `ClusterPool`. |
325f50bc | 9 | * |
729c563d S |
10 | * When this worker is inactive for more than the given `maxInactiveTime`, |
11 | * it will send a termination request to its main worker. | |
12 | * | |
13 | * If you use a `DynamicClusterPool` the extra workers that were created will be terminated, | |
14 | * but the minimum number of workers will be guaranteed. | |
15 | * | |
e102732c JB |
16 | * @typeParam Data - Type of data this worker receives from pool's execution. This can only be structured-cloneable data. |
17 | * @typeParam Response - Type of response the worker sends back to the main worker. This can only be structured-cloneable data. | |
325f50bc S |
18 | * @author [Christopher Quadflieg](https://github.com/Shinigami92) |
19 | * @since 2.0.0 | |
20 | */ | |
d3c8a1a8 | 21 | export class ClusterWorker< |
deb85c12 JB |
22 | Data = unknown, |
23 | Response = unknown | |
6677a3d3 | 24 | > extends AbstractWorker<Worker, Data, Response> { |
729c563d S |
25 | /** |
26 | * Constructs a new poolifier cluster worker. | |
27 | * | |
a86b6df1 | 28 | * @param taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked. |
38e795c1 | 29 | * @param opts - Options for the worker. |
729c563d | 30 | */ |
d4aeae5a | 31 | public constructor ( |
82ea6492 | 32 | taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>, |
d4aeae5a JB |
33 | opts: WorkerOptions = {} |
34 | ) { | |
7e0d447f JB |
35 | super( |
36 | 'worker-cluster-pool:poolifier', | |
37 | cluster.isPrimary, | |
6677a3d3 | 38 | cluster.worker as Worker, |
85aeb3f3 | 39 | taskFunctions, |
7e0d447f JB |
40 | opts |
41 | ) | |
85aeb3f3 JB |
42 | } |
43 | ||
44 | /** @inheritDoc */ | |
45 | protected handleReadyMessage (message: MessageValue<Data>): void { | |
6c0c538c | 46 | if (!this.isMain && message.workerId === this.id && message.ready != null) { |
7e627c2a | 47 | this.getMainWorker()?.on('message', this.messageListener.bind(this)) |
6c0c538c | 48 | this.sendToMainWorker({ ready: true, workerId: this.id }) |
85aeb3f3 | 49 | } |
f59e1027 JB |
50 | } |
51 | ||
52 | /** @inheritDoc */ | |
53 | protected get id (): number { | |
54 | return this.getMainWorker().id | |
325f50bc S |
55 | } |
56 | ||
afc003b2 | 57 | /** @inheritDoc */ |
c97c7edb | 58 | protected sendToMainWorker (message: MessageValue<Response>): void { |
6677a3d3 | 59 | this.getMainWorker().send(message) |
325f50bc | 60 | } |
325f50bc | 61 | } |