X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fpools%2Fworker.ts;h=9c8b77fc623b68ed2a25aed883531dfa5e25cf70;hb=4aeb640dc15908e9d2d903642da6f439baf135f3;hp=1a94ef60950dffe84e9430374dcd13395a956bab;hpb=c3719753af0a9be03abf722a7543495359e817b5;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index 1a94ef60..9c8b77fc 100644 --- a/src/pools/worker.ts +++ b/src/pools/worker.ts @@ -1,4 +1,4 @@ -import type { MessageChannel } from 'node:worker_threads' +import type { MessageChannel, WorkerOptions } from 'node:worker_threads' import type { EventEmitter } from 'node:events' import type { CircularArray } from '../circular-array' import type { Task } from '../utility-types' @@ -154,6 +154,11 @@ export interface WorkerInfo { * Ready flag. */ ready: boolean + /** + * Stealing flag. + * This flag is set to `true` when worker node is stealing tasks from another worker node. + */ + stealing: boolean /** * Task function names. */ @@ -198,12 +203,15 @@ export interface StrategyData { */ export interface IWorker { /** - * Worker id. + * Cluster worker id. */ readonly id?: number + /** + * Worker thread worker id. + */ readonly threadId?: number /** - * Registers an event listener. + * Registers an event handler. * * @param event - The event. * @param handler - The event handler. @@ -217,7 +225,7 @@ export interface IWorker { | ExitHandler ) => void /** - * Registers once an event listener. + * Registers once an event handler. * * @param event - The event. * @param handler - The event handler. @@ -230,6 +238,19 @@ export interface IWorker { | ErrorHandler | ExitHandler ) => void + /** + * Stop all JavaScript execution in the worker thread as soon as possible. + * Returns a Promise for the exit code that is fulfilled when the `'exit' event` is emitted. + */ + readonly terminate?: () => Promise + /** + * Cluster worker disconnect. + */ + readonly disconnect?: () => void + /** + * Cluster worker kill. + */ + readonly kill?: (signal?: string) => void } /** @@ -270,7 +291,7 @@ export interface IWorkerNode */ strategyData?: StrategyData /** - * Message channel (worker_threads only). + * Message channel (worker thread only). */ readonly messageChannel?: MessageChannel /** @@ -325,18 +346,18 @@ export interface IWorkerNode */ readonly resetUsage: () => void /** - * Closes communication channel. + * Terminates the worker node. */ - readonly closeChannel: () => void + readonly terminate: () => Promise /** * Registers a worker event handler. * * @param event - The event. - * @param listener - The event listener. + * @param handler - The event handler. */ readonly registerWorkerEventHandler: ( event: string, - listener: + handler: | OnlineHandler | MessageHandler | ErrorHandler @@ -346,11 +367,11 @@ export interface IWorkerNode * Registers once a worker event handler. * * @param event - The event. - * @param listener - The event listener. + * @param handler - The event handler. */ readonly registerOnceWorkerEventHandler: ( event: string, - listener: + handler: | OnlineHandler | MessageHandler | ErrorHandler