import {
- MessageChannel,
SHARE_ENV,
Worker,
+ type WorkerOptions,
isMainThread
} from 'node:worker_threads'
-import type { Draft, MessageValue } from '../../utility-types'
+import type { MessageValue } from '../../utility-types'
import { AbstractPool } from '../abstract-pool'
-import {
- type PoolOptions,
- type PoolType,
- PoolTypes,
- type WorkerType,
- WorkerTypes
-} from '../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<MessageChannel>
+export interface ThreadPoolOptions extends PoolOptions<Worker> {
+ /**
+ * Worker options.
+ *
+ * @see https://nodejs.org/api/worker_threads.html#new-workerfilename-options
+ */
+ workerOptions?: WorkerOptions
+}
/**
* 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.
- *
- * @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.
+ * @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<ThreadWorkerWithMessageChannel, Data, Response> {
+> extends AbstractPool<Worker, Data, Response> {
/**
* Constructs a new poolifier fixed thread pool.
*
public constructor (
numberOfThreads: number,
filePath: string,
- opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
+ protected readonly opts: ThreadPoolOptions = {}
) {
super(numberOfThreads, filePath, opts)
}
}
/** @inheritDoc */
- protected async destroyWorker (
- worker: ThreadWorkerWithMessageChannel
- ): Promise<void> {
- this.sendToWorker(worker, { kill: 1 })
+ protected async destroyWorker (worker: Worker): Promise<void> {
+ this.sendToWorker(worker, { kill: true, workerId: worker.threadId })
await worker.terminate()
}
/** @inheritDoc */
- protected sendToWorker (
- worker: ThreadWorkerWithMessageChannel,
- message: MessageValue<Data>
- ): void {
+ protected sendToWorker (worker: Worker, message: MessageValue<Data>): void {
worker.postMessage(message)
}
/** @inheritDoc */
- protected registerWorkerMessageListener<Message extends Data | Response>(
- worker: ThreadWorkerWithMessageChannel,
- listener: (message: MessageValue<Message>) => void
- ): void {
- worker.port2?.on('message', listener)
- }
-
- /** @inheritDoc */
- protected createWorker (): ThreadWorkerWithMessageChannel {
+ protected createWorker (): Worker {
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
- // Listen to worker messages.
- this.registerWorkerMessageListener(worker, super.workerListener())
- }
-
/** @inheritDoc */
protected get type (): PoolType {
return PoolTypes.fixed