Commit | Line | Data |
---|---|---|
c4855468 | 1 | import { PoolType } from '../pool' |
c97c7edb | 2 | import type { ClusterPoolOptions } from './fixed' |
325f50bc | 3 | import { FixedClusterPool } from './fixed' |
f045358d | 4 | |
4ade5f1f | 5 | /** |
729c563d | 6 | * A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers. |
4ade5f1f | 7 | * |
729c563d | 8 | * This cluster pool creates new workers when the others are busy, up to the maximum number of workers. |
9cd39dd4 | 9 | * When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's `emitter`. |
729c563d | 10 | * |
38e795c1 JB |
11 | * @typeParam Data - Type of data sent to the worker. This can only be serializable data. |
12 | * @typeParam Response - Type of response of execution. This can only be serializable data. | |
325f50bc S |
13 | * @author [Christopher Quadflieg](https://github.com/Shinigami92) |
14 | * @since 2.0.0 | |
4ade5f1f | 15 | */ |
325f50bc | 16 | export class DynamicClusterPool< |
deb85c12 JB |
17 | Data = unknown, |
18 | Response = unknown | |
325f50bc | 19 | > extends FixedClusterPool<Data, Response> { |
4ade5f1f | 20 | /** |
729c563d S |
21 | * Constructs a new poolifier dynamic cluster pool. |
22 | * | |
38e795c1 JB |
23 | * @param min - Minimum number of workers which are always active. |
24 | * @param max - Maximum number of workers that can be created by this pool. | |
25 | * @param filePath - Path to an implementation of a `ClusterWorker` file, which can be relative or absolute. | |
26 | * @param opts - Options for this dynamic cluster pool. | |
4ade5f1f S |
27 | */ |
28 | public constructor ( | |
c97c7edb | 29 | min: number, |
d2097c13 | 30 | public readonly max: number, |
31b90205 | 31 | filePath: string, |
ed6dd37f | 32 | opts: ClusterPoolOptions = {} |
4ade5f1f | 33 | ) { |
31b90205 | 34 | super(min, filePath, opts) |
4ade5f1f S |
35 | } |
36 | ||
afc003b2 | 37 | /** @inheritDoc */ |
7c0ba920 JB |
38 | public get type (): PoolType { |
39 | return PoolType.DYNAMIC | |
40 | } | |
41 | ||
afc003b2 | 42 | /** @inheritDoc */ |
c319c66b | 43 | protected get full (): boolean { |
f06e48d8 | 44 | return this.workerNodes.length === this.max |
4ade5f1f | 45 | } |
c2ade475 | 46 | |
afc003b2 | 47 | /** @inheritDoc */ |
c319c66b | 48 | protected get busy (): boolean { |
0527b6db | 49 | return this.full && this.internalBusy() |
c2ade475 | 50 | } |
4ade5f1f | 51 | } |