X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fthread%2Ffixed.ts;h=a9d8f685fec3432db4fc6829dabcfd84f146babe;hb=d1c03778bd26af064147055fc21d6701ffefb707;hp=021de492540f50884a8e554d570f5194061212d0;hpb=a35560bac09e829e1e19f88f8fd1d71a64c9d50b;p=poolifier.git diff --git a/src/pools/thread/fixed.ts b/src/pools/thread/fixed.ts index 021de492..f48d0bcd 100644 --- a/src/pools/thread/fixed.ts +++ b/src/pools/thread/fixed.ts @@ -1,92 +1,135 @@ -import { isMainThread, MessageChannel, SHARE_ENV, Worker } from 'worker_threads' -import type { Draft, MessageValue } from '../../utility-types' -import type { PoolOptions } from '../abstract-pool' +import { + type MessageChannel, + type MessagePort, + type TransferListItem, + type Worker, + isMainThread +} from 'node:worker_threads' +import type { MessageValue } from '../../utility-types' import { AbstractPool } from '../abstract-pool' +import { type PoolOptions, type PoolType, PoolTypes } from '../pool' +import { type WorkerType, WorkerTypes } from '../worker' /** - * 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 type ThreadPoolOptions = PoolOptions /** * 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 } + opts: ThreadPoolOptions = {}, + maximumNumberOfThreads?: number ) { - super(numberOfThreads, filePath, opts) + super(numberOfThreads, filePath, opts, maximumNumberOfThreads) } + /** @inheritDoc */ protected isMain (): boolean { return isMainThread } - /** @inheritdoc */ - public async destroyWorker ( - worker: ThreadWorkerWithMessageChannel - ): Promise { - this.sendToWorker(worker, { kill: 1 }) - await worker.terminate() + /** @inheritDoc */ + protected sendToWorker ( + workerNodeKey: number, + message: MessageValue, + transferList?: TransferListItem[] + ): void { + this.workerNodes[workerNodeKey].messageChannel?.port1?.postMessage( + { ...message, workerId: this.getWorkerInfo(workerNodeKey).id }, + transferList + ) + } + + /** @inheritDoc */ + protected sendStartupMessageToWorker (workerNodeKey: number): void { + const workerNode = this.workerNodes[workerNodeKey] + const port2: MessagePort = (workerNode.messageChannel as MessageChannel) + .port2 + workerNode.worker.postMessage( + { + ready: false, + workerId: this.getWorkerInfo(workerNodeKey).id, + port: port2 + }, + [port2] + ) } - protected sendToWorker ( - worker: ThreadWorkerWithMessageChannel, - message: MessageValue + /** @inheritDoc */ + protected registerWorkerMessageListener( + workerNodeKey: number, + listener: (message: MessageValue) => void ): void { - worker.postMessage(message) + this.workerNodes[workerNodeKey].messageChannel?.port1?.on( + 'message', + listener + ) } - /** @inheritdoc */ - public registerWorkerMessageListener ( - messageChannel: ThreadWorkerWithMessageChannel, + /** @inheritDoc */ + protected registerOnceWorkerMessageListener( + workerNodeKey: number, listener: (message: MessageValue) => void ): void { - messageChannel.port2?.on('message', listener) + this.workerNodes[workerNodeKey].messageChannel?.port1?.once( + 'message', + listener + ) } - protected unregisterWorkerMessageListener ( - messageChannel: ThreadWorkerWithMessageChannel, + /** @inheritDoc */ + protected deregisterWorkerMessageListener( + workerNodeKey: number, listener: (message: MessageValue) => void ): void { - messageChannel.port2?.removeListener('message', listener) + this.workerNodes[workerNodeKey].messageChannel?.port1?.off( + 'message', + listener + ) + } + + /** @inheritDoc */ + protected shallCreateDynamicWorker (): boolean { + return false + } + + /** @inheritDoc */ + protected checkAndEmitDynamicWorkerCreationEvents (): void { + /* noop */ + } + + /** @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 } - 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() } }