X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fthread%2Fdynamic.ts;h=8e795512694aa41a2ea82b9c727e3ebd348b01c9;hb=bcf1c155ec2e2d9208c8f818abd031662bd61d7f;hp=86950b43a6de1d79431a587b0d42f78e91bcb99a;hpb=1a81f8af06213d08267e8e7d593c5ec7be087535;p=poolifier.git diff --git a/src/pools/thread/dynamic.ts b/src/pools/thread/dynamic.ts index 86950b43..8e795512 100644 --- a/src/pools/thread/dynamic.ts +++ b/src/pools/thread/dynamic.ts @@ -1,77 +1,62 @@ -import type { JSONValue } from '../../utility-types' -import { isKillBehavior, KillBehaviors } from '../../worker/worker-options' -import type { PoolOptions } from '../abstract-pool' -import type { ThreadWorkerWithMessageChannel } from './fixed' -import { FixedThreadPool } from './fixed' +import { PoolEvents, type PoolType, PoolTypes } from '../pool.js' +import { checkDynamicPoolSize } from '../utils.js' +import { FixedThreadPool, type ThreadPoolOptions } from './fixed.js' /** * A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads. * * This thread pool creates new threads when the others are busy, up to the maximum number of threads. - * When the maximum number of threads is reached, an event is emitted. If you want to listen to this event, use the pool's `emitter`. - * - * @template Data Type of data sent to the worker. - * @template Response Type of response of execution. + * When the maximum number of threads is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's `emitter`. * + * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. + * @typeParam Response - Type of execution response. This can only be structured-cloneable data. * @author [Alessandro Pio Ardizio](https://github.com/pioardi) * @since 0.0.1 */ export class DynamicThreadPool< - Data extends JSONValue = JSONValue, - Response extends JSONValue = JSONValue + Data = unknown, + Response = unknown > extends FixedThreadPool { /** * Constructs a new poolifier dynamic thread pool. * - * @param min Minimum number of threads which are always active. - * @param max Maximum number of threads that can be created by this pool. - * @param filename Path to an implementation of a `ThreadWorker` file, which can be relative or absolute. - * @param opts Options for this fixed thread pool. Default: `{ maxTasks: 1000 }` + * @param min - Minimum number of threads which are always active. + * @param max - Maximum number of threads that can be created by this pool. + * @param filePath - Path to an implementation of a `ThreadWorker` file, which can be relative or absolute. + * @param opts - Options for this dynamic thread pool. */ public constructor ( min: number, - public readonly max: number, - filename: string, - opts: PoolOptions = { maxTasks: 1000 } + max: number, + filePath: string, + opts: ThreadPoolOptions = {} ) { - super(min, filename, opts) + super(min, filePath, opts, max) + checkDynamicPoolSize( + this.minimumNumberOfWorkers, + this.maximumNumberOfWorkers + ) } - /** - * Choose a thread for the next task. - * - * It will first check for and return an idle thread. - * If all threads are busy, then it will try to create a new one up to the `max` thread count. - * If the max thread count is reached, the emitter will emit a `FullPool` event and it will fall back to using a round robin algorithm to distribute the load. - * - * @returns Thread worker. - */ - protected chooseWorker (): ThreadWorkerWithMessageChannel { - for (const [worker, numberOfTasks] of this.tasks) { - if (numberOfTasks === 0) { - // A worker is free, use it - return worker - } - } + /** @inheritDoc */ + protected shallCreateDynamicWorker (): boolean { + return (!this.full && this.internalBusy()) || this.empty + } - if (this.workers.length === this.max) { - this.emitter.emit('FullPool') - return super.chooseWorker() + /** @inheritDoc */ + protected checkAndEmitDynamicWorkerCreationEvents (): void { + if (this.full) { + this.emitter?.emit(PoolEvents.full, this.info) } + } + + /** @inheritDoc */ + protected get type (): PoolType { + return PoolTypes.dynamic + } - // All workers are busy, create a new worker - const workerCreated = this.createAndSetupWorker() - this.registerWorkerMessageListener(workerCreated, message => { - const tasksInProgress = this.tasks.get(workerCreated) - if ( - isKillBehavior(KillBehaviors.HARD, message.kill) || - tasksInProgress === 0 - ) { - // Kill received from the worker, means that no new tasks are submitted to that worker for a while ( > maxInactiveTime) - this.sendToWorker(workerCreated, { kill: 1 }) - void this.destroyWorker(workerCreated) - } - }) - return workerCreated + /** @inheritDoc */ + protected get busy (): boolean { + return this.full && this.internalBusy() } }