X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fcluster-worker.ts;h=c43e7f75a7586d2b2a9fa6633eea7da6e44697bf;hb=d881a2047924280a33a738d1df42257af1c8ef22;hp=4deeb9ae6ebebb2cb960ebf4b8fd489c0aa3f258;hpb=f2fdaa86fd9e6f3a5dc0b3146c065e3a7bfb44e0;p=poolifier.git diff --git a/src/worker/cluster-worker.ts b/src/worker/cluster-worker.ts index 4deeb9ae..c43e7f75 100644 --- a/src/worker/cluster-worker.ts +++ b/src/worker/cluster-worker.ts @@ -1,51 +1,55 @@ -import type { Worker } from 'cluster' -import { isMaster, worker } from 'cluster' -import type { JSONValue, MessageValue } from '../utility-types' +import cluster, { type Worker } from 'node:cluster' +import type { MessageValue } from '../utility-types' import { AbstractWorker } from './abstract-worker' import type { WorkerOptions } from './worker-options' +import type { TaskFunctions, WorkerFunction } from './worker-functions' /** - * An example worker that will be always alive, you just need to **extend** this class if you want a static pool. + * A cluster worker used by a poolifier `ClusterPool`. * - * When this worker is inactive for more than 1 minute, it will send this info to the main worker, - * if you are using DynamicClusterPool, the workers created after will be killed, the min num of worker will be guaranteed. + * When this worker is inactive for more than the given `maxInactiveTime`, + * it will send a termination request to its main worker. * + * If you use a `DynamicClusterPool` the extra workers that were created will be terminated, + * but the minimum number of workers will be guaranteed. + * + * @typeParam Data - Type of data this worker receives from pool's execution. This can only be structured-cloneable data. + * @typeParam Response - Type of response the worker sends back to the main worker. This can only be structured-cloneable data. * @author [Christopher Quadflieg](https://github.com/Shinigami92) * @since 2.0.0 */ export class ClusterWorker< - Data extends JSONValue = JSONValue, - Response extends JSONValue = JSONValue + Data = unknown, + Response = unknown > extends AbstractWorker { - public constructor (fn: (data: Data) => Response, opts: WorkerOptions = {}) { - super('worker-cluster-pool:pioardi', isMaster, fn, opts) - - worker.on('message', (value: MessageValue) => { - if (value?.data && value.id) { - // here you will receive messages - // console.log('This is the main worker ' + isMaster) - if (this.async) { - this.runInAsyncScope(this.runAsync.bind(this), this, fn, value) - } else { - this.runInAsyncScope(this.run.bind(this), this, fn, value) - } - } else if (value.kill) { - // here is time to kill this worker, just clearing the interval - if (this.interval) clearInterval(this.interval) - this.emitDestroy() - } - }) + /** + * Constructs a new poolifier cluster worker. + * + * @param taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked. + * @param opts - Options for the worker. + */ + public constructor ( + taskFunctions: + | WorkerFunction + | TaskFunctions, + opts: WorkerOptions = {} + ) { + super( + 'worker-cluster-pool:poolifier', + cluster.isPrimary, + taskFunctions, + cluster.worker as Worker, + opts + ) } - protected getMainWorker (): Worker { - return worker + /** @inheritDoc */ + protected get id (): number { + return this.getMainWorker().id } + /** @inheritDoc */ protected sendToMainWorker (message: MessageValue): void { this.getMainWorker().send(message) } - - protected handleError (e: Error | string): string { - return e instanceof Error ? e.message : e - } }