X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fthread%2Ffixed.ts;h=ac629e1fb0ff7f363be0a3fe5107f2b02748c8d8;hb=369d0a5139123c2b62260d5793b36097479b23a2;hp=021de492540f50884a8e554d570f5194061212d0;hpb=a35560bac09e829e1e19f88f8fd1d71a64c9d50b;p=poolifier.git diff --git a/src/pools/thread/fixed.ts b/src/pools/thread/fixed.ts index 021de492..ac629e1f 100644 --- a/src/pools/thread/fixed.ts +++ b/src/pools/thread/fixed.ts @@ -1,92 +1,104 @@ -import { isMainThread, MessageChannel, SHARE_ENV, Worker } from 'worker_threads' -import type { Draft, MessageValue } from '../../utility-types' -import type { PoolOptions } from '../abstract-pool' +import { + SHARE_ENV, + Worker, + type WorkerOptions, + isMainThread +} from 'node:worker_threads' +import type { MessageValue } from '../../utility-types' import { AbstractPool } from '../abstract-pool' +import { + type PoolOptions, + type PoolType, + PoolTypes, + type WorkerType, + WorkerTypes +} from '../pool' /** - * A thread worker with message channels for communication between main thread and thread worker. + * Options for a poolifier thread pool. */ -export type ThreadWorkerWithMessageChannel = Worker & Draft +export interface ThreadPoolOptions extends PoolOptions { + /** + * Worker options. + * + * @see https://nodejs.org/api/worker_threads.html#new-workerfilename-options + */ + workerOptions?: WorkerOptions +} /** * A thread pool with a fixed number of threads. * - * It is possible to perform tasks in sync or asynchronous mode as you prefer. - * - * This pool selects the threads in a round robin fashion. - * - * @template Data Type of data sent to the worker. This can only be serializable data. - * @template Response Type of response of execution. This can only be serializable data. - * + * @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 FixedThreadPool< Data = unknown, Response = unknown -> extends AbstractPool { +> extends AbstractPool { /** * Constructs a new poolifier fixed thread pool. * - * @param numberOfThreads Number of threads for this pool. - * @param filePath 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 numberOfThreads - Number of threads for this pool. + * @param filePath - Path to an implementation of a `ThreadWorker` file, which can be relative or absolute. + * @param opts - Options for this fixed thread pool. */ public constructor ( numberOfThreads: number, filePath: string, - opts: PoolOptions = { maxTasks: 1000 } + protected readonly opts: ThreadPoolOptions = {} ) { super(numberOfThreads, filePath, opts) } + /** @inheritDoc */ protected isMain (): boolean { return isMainThread } - /** @inheritdoc */ - public async destroyWorker ( - worker: ThreadWorkerWithMessageChannel - ): Promise { + /** @inheritDoc */ + protected async destroyWorker (worker: Worker): Promise { this.sendToWorker(worker, { kill: 1 }) await worker.terminate() } - protected sendToWorker ( - worker: ThreadWorkerWithMessageChannel, - message: MessageValue - ): void { + /** @inheritDoc */ + protected sendToWorker (worker: Worker, message: MessageValue): void { worker.postMessage(message) } - /** @inheritdoc */ - public registerWorkerMessageListener ( - messageChannel: ThreadWorkerWithMessageChannel, - listener: (message: MessageValue) => void - ): void { - messageChannel.port2?.on('message', listener) + /** @inheritDoc */ + protected createWorker (): Worker { + return new Worker(this.filePath, { + env: SHARE_ENV, + ...this.opts.workerOptions + }) } - protected unregisterWorkerMessageListener ( - messageChannel: ThreadWorkerWithMessageChannel, - listener: (message: MessageValue) => void - ): void { - messageChannel.port2?.removeListener('message', listener) + /** @inheritDoc */ + protected get type (): PoolType { + return PoolTypes.fixed } - protected createWorker (): ThreadWorkerWithMessageChannel { - return new Worker(this.filePath, { - env: SHARE_ENV - }) + /** @inheritDoc */ + protected get worker (): WorkerType { + return WorkerTypes.thread + } + + /** @inheritDoc */ + protected get minSize (): number { + return this.numberOfWorkers + } + + /** @inheritDoc */ + protected get maxSize (): number { + return this.numberOfWorkers } - protected afterWorkerSetup (worker: ThreadWorkerWithMessageChannel): void { - const { port1, port2 } = new MessageChannel() - worker.postMessage({ parent: port1 }, [port1]) - worker.port1 = port1 - worker.port2 = port2 - // We will attach a listener for every task, - // when task is completed the listener will be removed but to avoid warnings we are increasing the max listeners size - worker.port2.setMaxListeners(this.opts.maxTasks ?? 1000) + /** @inheritDoc */ + protected get busy (): boolean { + return this.internalBusy() } }