-import { isMainThread, MessageChannel, SHARE_ENV, Worker } from 'worker_threads'
-import type { Draft, JSONValue, MessageValue } from '../../utility-types'
-import type { PoolOptions } from '../abstract-pool'
+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,
+ type PoolType,
+ PoolTypes,
+ type WorkerType,
+ WorkerTypes
+} from '../pool'
+
+/**
+ * Options for a poolifier thread pool.
+ */
+export interface ThreadPoolOptions extends PoolOptions<Worker> {
+ /**
+ * 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.
*
* 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.
- * @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 execution response. 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<ThreadWorkerWithMessageChannel, Data, Response> {
/**
* 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<ThreadWorkerWithMessageChannel> = { maxTasks: 1000 }
+ protected readonly opts: ThreadPoolOptions = {}
) {
super(numberOfThreads, filePath, opts)
}
+ /** @inheritDoc */
protected isMain (): boolean {
return isMainThread
}
+ /** @inheritDoc */
protected async destroyWorker (
worker: ThreadWorkerWithMessageChannel
): Promise<void> {
+ this.sendToWorker(worker, { kill: 1 })
await worker.terminate()
}
+ /** @inheritDoc */
protected sendToWorker (
worker: ThreadWorkerWithMessageChannel,
message: MessageValue<Data>
worker.postMessage(message)
}
- protected registerWorkerMessageListener<Message extends Data | Response> (
- messageChannel: ThreadWorkerWithMessageChannel,
- listener: (message: MessageValue<Message>) => void
- ): void {
- messageChannel.port2?.on('message', listener)
- }
-
- protected unregisterWorkerMessageListener<Message extends Data | Response> (
- messageChannel: ThreadWorkerWithMessageChannel,
+ /** @inheritDoc */
+ protected registerWorkerMessageListener<Message extends Data | Response>(
+ worker: ThreadWorkerWithMessageChannel,
listener: (message: MessageValue<Message>) => void
): void {
- messageChannel.port2?.removeListener('message', listener)
+ worker.port2?.on('message', listener)
}
+ /** @inheritDoc */
protected createWorker (): ThreadWorkerWithMessageChannel {
return new Worker(this.filePath, {
- env: SHARE_ENV
+ env: SHARE_ENV,
+ ...this.opts.workerOptions
})
}
+ /** @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 */
+ 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 */
+ protected get busy (): boolean {
+ return this.internalBusy()
}
}