X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fthread%2Ffixed.ts;h=e7d3a727f1e2e7d0804815037c875db5e8963749;hb=c319c66bad0611acf6087950a1f8a20f8124167b;hp=bfd6f016d0d4f08525d1c19435d4a138e2a404a0;hpb=45dbbb14328a173cad05ddcf21b5acf7f6460bb8;p=poolifier.git diff --git a/src/pools/thread/fixed.ts b/src/pools/thread/fixed.ts index bfd6f016..e7d3a727 100644 --- a/src/pools/thread/fixed.ts +++ b/src/pools/thread/fixed.ts @@ -1,7 +1,13 @@ -import { isMainThread, MessageChannel, SHARE_ENV, Worker } from 'worker_threads' -import type { Draft, JSONValue, MessageValue } from '../../utility-types' -import type { PoolOptions } from '../abstract-pool' +import { + isMainThread, + MessageChannel, + SHARE_ENV, + Worker +} 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' /** * A thread worker with message channels for communication between main thread and thread worker. @@ -15,41 +21,44 @@ export type ThreadWorkerWithMessageChannel = Worker & Draft * * This pool selects the threads in a round robin fashion. * - * @template Data Type of data sent to the worker. - * @template Response Type of response of execution. - * + * @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. * @author [Alessandro Pio Ardizio](https://github.com/pioardi) * @since 0.0.1 */ export class FixedThreadPool< - Data extends JSONValue = JSONValue, - Response extends JSONValue = JSONValue + Data = unknown, + Response = unknown > 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 } + opts: PoolOptions = {} ) { super(numberOfThreads, filePath, opts) } + /** @inheritDoc */ protected isMain (): boolean { return isMainThread } - protected async destroyWorker ( + /** @inheritDoc */ + public async destroyWorker ( worker: ThreadWorkerWithMessageChannel ): Promise { + this.sendToWorker(worker, { kill: 1 }) await worker.terminate() } + /** @inheritDoc */ protected sendToWorker ( worker: ThreadWorkerWithMessageChannel, message: MessageValue @@ -57,33 +66,43 @@ export class FixedThreadPool< worker.postMessage(message) } - protected registerWorkerMessageListener ( - port: ThreadWorkerWithMessageChannel, - listener: (message: MessageValue) => void + /** @inheritDoc */ + protected registerWorkerMessageListener( + messageChannel: ThreadWorkerWithMessageChannel, + listener: (message: MessageValue) => void ): void { - port.port2?.on('message', listener) - } - - protected unregisterWorkerMessageListener ( - port: ThreadWorkerWithMessageChannel, - listener: (message: MessageValue) => void - ): void { - port.port2?.removeListener('message', listener) + messageChannel.port2?.on('message', listener) } + /** @inheritDoc */ protected createWorker (): ThreadWorkerWithMessageChannel { return new Worker(this.filePath, { env: SHARE_ENV }) } + /** @inheritDoc */ 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) + // Listen to worker messages. + this.registerWorkerMessageListener(worker, super.workerListener()) + } + + /** @inheritDoc */ + public get type (): PoolType { + return PoolType.FIXED + } + + /** @inheritDoc */ + protected get full (): boolean { + return this.workerNodes.length === this.numberOfWorkers + } + + /** @inheritDoc */ + protected get busy (): boolean { + return this.internalBusy() } }