X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fthread-worker.ts;h=ec5dea8ef74cc4a1dbac377f3f50eaad21c10b8f;hb=7b451fe3face8bd59d2d387b19a01f724b5f9585;hp=a6c9ec16b64760e8f4a79feeebef0339634ff660;hpb=f2fdaa86fd9e6f3a5dc0b3146c065e3a7bfb44e0;p=poolifier.git diff --git a/src/worker/thread-worker.ts b/src/worker/thread-worker.ts index a6c9ec16..ec5dea8e 100644 --- a/src/worker/thread-worker.ts +++ b/src/worker/thread-worker.ts @@ -1,55 +1,90 @@ -import { isMainThread, parentPort } from 'worker_threads' -import type { JSONValue, MessageValue } from '../utility-types' +import { + type MessagePort, + isMainThread, + parentPort, + threadId +} from 'node:worker_threads' +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 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. + * + * @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 thread. This can only be structured-cloneable data. * @author [Alessandro Pio Ardizio](https://github.com/pioardi) * @since 0.0.1 */ export class ThreadWorker< - Data extends JSONValue = JSONValue, - Response extends JSONValue = JSONValue + Data = unknown, + Response = unknown > extends AbstractWorker { - protected parent?: MessagePort + /** + * Message port used to communicate with the main worker. + */ + private port!: MessagePort + /** + * Constructs a new poolifier thread 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-thread-pool:poolifier', + isMainThread, + parentPort as MessagePort, + taskFunctions, + opts + ) + } - public constructor (fn: (data: Data) => Response, opts: WorkerOptions = {}) { - super('worker-thread-pool:pioardi', isMainThread, fn, opts) + /** @inheritDoc */ + protected handleReadyMessage (message: MessageValue): void { + if ( + !this.isMain && + message.workerId === this.id && + message.ready != null && + message.port != null + ) { + this.port = message.port + this.port.on('message', this.messageListener.bind(this)) + this.sendToMainWorker({ ready: true, workerId: this.id }) + } + } - parentPort?.on('message', (value: MessageValue) => { - if (value?.data && value.id) { - // here you will receive messages - // console.log('This is the main worker ' + isMainThread) - 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() - } - }) + /** @inheritDoc */ + protected handleKillMessage (message: MessageValue): void { + super.handleKillMessage(message) + this.port?.unref() + this.port?.close() } - protected getMainWorker (): MessagePort { - if (!this.parent) { - throw new Error('Parent was not set') - } - return this.parent + /** @inheritDoc */ + protected get id (): number { + return threadId } + /** @inheritDoc */ protected sendToMainWorker (message: MessageValue): void { - this.getMainWorker().postMessage(message) + this.port.postMessage(message) + } + + /** @inheritDoc */ + protected handleError (e: Error | string): string { + return e as string } }