import { isMainThread, MessageChannel, SHARE_ENV, Worker } from 'worker_threads'
import type { Draft, MessageValue } from '../../utility-types'
-import type { PoolOptions } from '../abstract-pool'
import { AbstractPool } from '../abstract-pool'
+import type { PoolOptions } from '../pool'
+import { PoolType } from '../pool-internal'
+/**
+ * A thread worker with message channels for communication between main thread and thread worker.
+ */
export type ThreadWorkerWithMessageChannel = Worker & Draft<MessageChannel>
/**
- * A thread pool with a static number of threads, is possible to execute tasks in sync or async mode as you prefer.
+ * 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 will select the worker thread in a round robin fashion.
+ * 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.
* @author [Alessandro Pio Ardizio](https://github.com/pioardi)
* @since 0.0.1
*/
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export class FixedThreadPool<Data = any, Response = any> extends AbstractPool<
- ThreadWorkerWithMessageChannel,
- Data,
- Response
-> {
+export class FixedThreadPool<
+ Data = unknown,
+ Response = unknown
+> extends AbstractPool<ThreadWorkerWithMessageChannel, Data, Response> {
/**
- * @param numThreads Num of threads for this worker pool.
- * @param filePath A file path with implementation of `ThreadWorker` class, relative path is fine.
- * @param opts An object with possible options for example `errorHandler`, `onlineHandler`. Default: `{ maxTasks: 1000 }`
+ * 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.
*/
public constructor (
- numThreads: number,
+ numberOfThreads: number,
filePath: string,
- opts: PoolOptions<ThreadWorkerWithMessageChannel> = { maxTasks: 1000 }
+ opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
) {
- super(numThreads, filePath, opts)
+ super(numberOfThreads, filePath, opts)
}
+ /** {@inheritDoc} */
protected isMain (): boolean {
return isMainThread
}
- protected async destroyWorker (
+ /** {@inheritDoc} */
+ public 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 (
- port: ThreadWorkerWithMessageChannel,
- listener: (message: MessageValue<Response>) => void
- ): void {
- port.port2?.on('message', listener)
- }
-
- protected unregisterWorkerMessageListener (
- port: ThreadWorkerWithMessageChannel,
- listener: (message: MessageValue<Response>) => void
+ /** {@inheritDoc} */
+ public registerWorkerMessageListener<Message extends Data | Response>(
+ messageChannel: ThreadWorkerWithMessageChannel,
+ listener: (message: MessageValue<Message>) => void
): void {
- port.port2?.removeListener('message', listener)
+ messageChannel.port2?.on('message', listener)
}
- protected newWorker (): ThreadWorkerWithMessageChannel {
+ /** {@inheritDoc} */
+ protected createWorker (): ThreadWorkerWithMessageChannel {
return new Worker(this.filePath, {
env: SHARE_ENV
})
}
- protected afterNewWorkerPushed (
- worker: ThreadWorkerWithMessageChannel
- ): void {
+ /** {@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} */
+ public get busy (): boolean {
+ return this.internalGetBusyStatus()
}
}