X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fthread%2Ffixed.ts;h=a9d8f685fec3432db4fc6829dabcfd84f146babe;hb=cd4d348a1b1b8f3850385957f62cb8e37f19d9b8;hp=a37ccbf76b5864b8cc4f27b847596d7b9c533d38;hpb=fc3e65861bc1939ae047ee1e8e91a1ce577035f4;p=poolifier.git diff --git a/src/pools/thread/fixed.ts b/src/pools/thread/fixed.ts index a37ccbf7..a9d8f685 100644 --- a/src/pools/thread/fixed.ts +++ b/src/pools/thread/fixed.ts @@ -1,13 +1,31 @@ import { - isMainThread, MessageChannel, SHARE_ENV, - Worker + 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. @@ -22,7 +40,7 @@ export type ThreadWorkerWithMessageChannel = Worker & Draft * This pool selects the threads in a round robin fashion. * * @typeParam Data - Type of data sent to the worker. This can only be serializable data. - * @typeParam Response - Type of response of execution. 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 */ @@ -40,25 +58,25 @@ export class FixedThreadPool< 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 @@ -66,22 +84,23 @@ 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]) @@ -91,13 +110,28 @@ export class FixedThreadPool< 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() } }