import type { PoolOptions } from '../abstract-pool'
import { AbstractPool } from '../abstract-pool'
+/**
+ * Options for a poolifier cluster pool.
+ */
export interface ClusterPoolOptions extends PoolOptions<Worker> {
/**
* Key/value pairs to add to worker process environment.
}
/**
- * A cluster pool with a static number of workers, is possible to execute tasks in sync or async mode as you prefer.
+ * A cluster pool with a fixed number of workers.
+ *
+ * It is possible to perform tasks in sync or asynchronous mode as you prefer.
+ *
+ * This pool selects the workers in a round robin fashion.
*
- * This pool will select the worker 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.
*
* @author [Christopher Quadflieg](https://github.com/Shinigami92)
* @since 2.0.0
*/
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export class FixedClusterPool<Data = any, Response = any> extends AbstractPool<
- Worker,
- Data,
- Response
-> {
+export class FixedClusterPool<
+ Data = unknown,
+ Response = unknown
+> extends AbstractPool<Worker, Data, Response> {
/**
- * @param numWorkers Number of workers for this pool.
- * @param filePath A file path with implementation of `ClusterWorker` class, relative path is fine.
- * @param opts An object with possible options for example `errorHandler`, `onlineHandler`. Default: `{ maxTasks: 1000 }`
+ * Constructs a new poolifier fixed cluster pool.
+ *
+ * @param numberOfWorkers Number of workers for this pool.
+ * @param filePath Path to an implementation of a `ClusterWorker` file, which can be relative or absolute.
+ * @param opts Options for this fixed cluster pool. Default: `{ maxTasks: 1000 }`
*/
public constructor (
- numWorkers: number,
+ numberOfWorkers: number,
filePath: string,
public readonly opts: ClusterPoolOptions = { maxTasks: 1000 }
) {
- super(numWorkers, filePath, opts)
+ super(numberOfWorkers, filePath, opts)
}
protected setupHook (): void {
return isMaster
}
- protected destroyWorker (worker: Worker): void {
+ /** @inheritdoc */
+ public destroyWorker (worker: Worker): void {
+ this.sendToWorker(worker, { kill: 1 })
worker.kill()
}
worker.send(message)
}
- protected registerWorkerMessageListener (
- port: Worker,
- listener: (message: MessageValue<Response>) => void
- ): void {
- port.on('message', listener)
- }
-
- protected unregisterWorkerMessageListener (
- port: Worker,
- listener: (message: MessageValue<Response>) => void
+ /** @inheritdoc */
+ public registerWorkerMessageListener<Message extends Data | Response> (
+ worker: Worker,
+ listener: (message: MessageValue<Message>) => void
): void {
- port.removeListener('message', listener)
+ worker.on('message', listener)
}
- protected newWorker (): Worker {
+ protected createWorker (): Worker {
return fork(this.opts.env)
}
- protected afterNewWorkerPushed (worker: Worker): void {
- // we will attach a listener for every task,
+ protected afterWorkerSetup (worker: Worker): void {
+ // 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.setMaxListeners(this.opts.maxTasks ?? 1000)
+ this.registerWorkerMessageListener(worker, super.workerListener())
}
}