| 1 | import { checkDynamicPoolSize } from '../utils.js' |
| 2 | import { PoolEvents, type PoolType, PoolTypes } from '../pool.js' |
| 3 | import { type ClusterPoolOptions, FixedClusterPool } from './fixed.js' |
| 4 | |
| 5 | /** |
| 6 | * A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers. |
| 7 | * |
| 8 | * This cluster pool creates new workers when the others are busy, up to the maximum number of workers. |
| 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`. |
| 10 | * |
| 11 | * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. |
| 12 | * @typeParam Response - Type of execution response. This can only be structured-cloneable data. |
| 13 | * @author [Christopher Quadflieg](https://github.com/Shinigami92) |
| 14 | * @since 2.0.0 |
| 15 | */ |
| 16 | export class DynamicClusterPool< |
| 17 | Data = unknown, |
| 18 | Response = unknown |
| 19 | > extends FixedClusterPool<Data, Response> { |
| 20 | /** |
| 21 | * Constructs a new poolifier dynamic cluster pool. |
| 22 | * |
| 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. |
| 27 | */ |
| 28 | public constructor ( |
| 29 | min: number, |
| 30 | max: number, |
| 31 | filePath: string, |
| 32 | opts: ClusterPoolOptions = {} |
| 33 | ) { |
| 34 | super(min, filePath, opts, max) |
| 35 | checkDynamicPoolSize( |
| 36 | this.minimumNumberOfWorkers, |
| 37 | // eslint-disable-next-line @typescript-eslint/no-non-null-assertion |
| 38 | this.maximumNumberOfWorkers! |
| 39 | ) |
| 40 | } |
| 41 | |
| 42 | /** @inheritDoc */ |
| 43 | protected shallCreateDynamicWorker (): boolean { |
| 44 | return !this.full && this.internalBusy() |
| 45 | } |
| 46 | |
| 47 | /** @inheritDoc */ |
| 48 | protected checkAndEmitDynamicWorkerCreationEvents (): void { |
| 49 | if (this.full) { |
| 50 | this.emitter?.emit(PoolEvents.full, this.info) |
| 51 | } |
| 52 | } |
| 53 | |
| 54 | /** @inheritDoc */ |
| 55 | protected get type (): PoolType { |
| 56 | return PoolTypes.dynamic |
| 57 | } |
| 58 | |
| 59 | /** @inheritDoc */ |
| 60 | protected get busy (): boolean { |
| 61 | return this.full && this.internalBusy() |
| 62 | } |
| 63 | } |