X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fthread%2Ffixed.ts;h=a9d8f685fec3432db4fc6829dabcfd84f146babe;hb=4f487526a63c873d168386250b40ad8103c5a4d8;hp=da3c0138387495eb63c9f8c1c9c29429088f6cbb;hpb=bdaf31cd0e637aa466c78d54a49f157899a2cb3f;p=poolifier.git diff --git a/src/pools/thread/fixed.ts b/src/pools/thread/fixed.ts index da3c0138..a9d8f685 100644 --- a/src/pools/thread/fixed.ts +++ b/src/pools/thread/fixed.ts @@ -1,8 +1,31 @@ -import { isMainThread, MessageChannel, SHARE_ENV, Worker } from 'worker_threads' +import { + MessageChannel, + SHARE_ENV, + Worker, + type WorkerOptions, + isMainThread +} from 'node:worker_threads' import type { Draft, MessageValue } from '../../utility-types' import { AbstractPool } from '../abstract-pool' -import type { PoolOptions } from '../pool' -import { PoolType } from '../pool-internal' +import { + type PoolOptions, + type PoolType, + PoolTypes, + type WorkerType, + WorkerTypes +} from '../pool' + +/** + * Options for a poolifier thread pool. + */ +export interface ThreadPoolOptions extends PoolOptions { + /** + * Worker options. + * + * @see https://nodejs.org/api/worker_threads.html#new-workerfilename-options + */ + workerOptions?: WorkerOptions +} /** * A thread worker with message channels for communication between main thread and thread worker. @@ -16,8 +39,8 @@ export type ThreadWorkerWithMessageChannel = Worker & Draft * * This pool selects the threads in a round robin fashion. * - * @template DataType of data sent to the worker. This can only be serializable data. - * @template ResponseType of response of execution. This can only be serializable data. + * @typeParam Data - Type of data sent to the worker. This can only be serializable data. + * @typeParam Response - Type of execution response. This can only be serializable data. * @author [Alessandro Pio Ardizio](https://github.com/pioardi) * @since 0.0.1 */ @@ -28,32 +51,32 @@ export class FixedThreadPool< /** * 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. + * @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 = {} + protected readonly opts: ThreadPoolOptions = {} ) { super(numberOfThreads, filePath, opts) } - /** @inheritdoc */ + /** @inheritDoc */ protected isMain (): boolean { return isMainThread } - /** @inheritdoc */ - public async destroyWorker ( + /** @inheritDoc */ + protected async destroyWorker ( worker: ThreadWorkerWithMessageChannel ): Promise { this.sendToWorker(worker, { kill: 1 }) await worker.terminate() } - /** @inheritdoc */ + /** @inheritDoc */ protected sendToWorker ( worker: ThreadWorkerWithMessageChannel, message: MessageValue @@ -61,38 +84,54 @@ export class FixedThreadPool< worker.postMessage(message) } - /** @inheritdoc */ - public registerWorkerMessageListener ( - messageChannel: ThreadWorkerWithMessageChannel, + /** @inheritDoc */ + protected registerWorkerMessageListener( + worker: ThreadWorkerWithMessageChannel, listener: (message: MessageValue) => void ): void { - messageChannel.port2?.on('message', listener) + worker.port2?.on('message', listener) } - /** @inheritdoc */ + /** @inheritDoc */ protected createWorker (): ThreadWorkerWithMessageChannel { return new Worker(this.filePath, { - env: SHARE_ENV + env: SHARE_ENV, + ...this.opts.workerOptions }) } - /** @inheritdoc */ + /** @inheritDoc */ protected afterWorkerSetup (worker: ThreadWorkerWithMessageChannel): void { const { port1, port2 } = new MessageChannel() worker.postMessage({ parent: port1 }, [port1]) worker.port1 = port1 worker.port2 = port2 - // Listen worker messages. + // Listen to worker messages. this.registerWorkerMessageListener(worker, super.workerListener()) } - /** @inheritdoc */ - public get type (): PoolType { - return PoolType.FIXED + /** @inheritDoc */ + protected get type (): PoolType { + return PoolTypes.fixed + } + + /** @inheritDoc */ + protected get worker (): WorkerType { + return WorkerTypes.thread + } + + /** @inheritDoc */ + protected get minSize (): number { + return this.numberOfWorkers + } + + /** @inheritDoc */ + protected get maxSize (): number { + return this.numberOfWorkers } - /** @inheritdoc */ - public get busy (): boolean { - return this.internalGetBusyStatus() + /** @inheritDoc */ + protected get busy (): boolean { + return this.internalBusy() } }