X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fthread-worker.ts;h=de1c36bf7b51fedf5b07b19ca9f09d4778daa933;hb=97c16550808cdcc2350561d6b369efdea3f5263d;hp=5a16026c497679a73332cc82a0fee704b5a5e72c;hpb=cda5cc74c77bdfc37b220ef19637876e221b5061;p=poolifier.git diff --git a/src/worker/thread-worker.ts b/src/worker/thread-worker.ts index 5a16026c..de1c36bf 100644 --- a/src/worker/thread-worker.ts +++ b/src/worker/thread-worker.ts @@ -1,56 +1,38 @@ +import type { MessagePort } from 'worker_threads' import { isMainThread, parentPort } from 'worker_threads' import type { MessageValue } from '../utility-types' import { AbstractWorker } from './abstract-worker' import type { WorkerOptions } from './worker-options' /** - * An example worker that will be always alive, you just need to **extend** this class if you want a static pool. + * A thread worker used by a poolifier `ThreadPool`. * - * When this worker is inactive for more than 1 minute, it will send this info to the main thread, - * if you are using DynamicThreadPool, the workers created after will be killed, the min num of thread will be guaranteed. + * When this worker is inactive for more than the given `maxInactiveTime`, + * it will send a termination request to its main thread. * + * If you use a `DynamicThreadPool` the extra workers that were created will be terminated, + * but the minimum number of workers will be guaranteed. + * + * @template DataType of data this worker receives from pool's execution. This can only be serializable data. + * @template ResponseType of response the worker sends back to the main thread. 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 ThreadWorker extends AbstractWorker< - MessagePort, - Data, - Response -> { - protected parent?: MessagePort - +export class ThreadWorker< + Data = unknown, + Response = unknown +> extends AbstractWorker { + /** + * Constructs a new poolifier thread worker. + * + * @param fn Function processed by the worker when the pool's `execution` function is invoked. + * @param opts Options for the worker. + */ public constructor (fn: (data: Data) => Response, opts: WorkerOptions = {}) { - super('worker-thread-pool:pioardi', isMainThread, fn, opts) - - parentPort?.on('message', (value: MessageValue) => { - if (value?.data && value.id) { - // here you will receive messages - // console.log('This is the main worker ' + isMain) - 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.parent) { - // save the port to communicate with the main thread - // this will be received once - this.parent = value.parent - } else if (value.kill) { - // here is time to kill this worker, just clearing the interval - if (this.interval) clearInterval(this.interval) - this.emitDestroy() - } - }) - } - - protected getMainWorker (): MessagePort { - if (!this.parent) { - throw new Error('Parent was not set') - } - return this.parent + super('worker-thread-pool:poolifier', isMainThread, fn, parentPort, opts) } + /** @inheritDoc */ protected sendToMainWorker (message: MessageValue): void { this.getMainWorker().postMessage(message) }