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