X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=9a27d8a5056bb7b4b222f2d210803699ab95ad0d;hb=3c8a79b4b146fb20de682c19d8b409bfbdf05df4;hp=5439606d420f0abd165b84c49157808de230aee6;hpb=e1c2dba7ec9c30556abfc492327abdc8957a664b;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index 5439606d..9a27d8a5 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' @@ -198,37 +198,65 @@ 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. */ - readonly on: ((event: 'online', handler: OnlineHandler) => void) & - ((event: 'message', handler: MessageHandler) => void) & - ((event: 'error', handler: ErrorHandler) => void) & - ((event: 'exit', handler: ExitHandler) => void) + readonly on: ( + event: string, + handler: + | OnlineHandler + | MessageHandler + | ErrorHandler + | ExitHandler + ) => void /** - * Registers a listener to the exit event that will only be performed once. + * Registers once an event handler. * - * @param event - The `'exit'` event. - * @param handler - The exit handler. + * @param event - The event. + * @param handler - The event handler. + */ + readonly once: ( + event: string, + handler: + | OnlineHandler + | MessageHandler + | 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 once: (event: 'exit', handler: ExitHandler) => void + readonly disconnect?: () => void + /** + * Cluster worker kill. + */ + readonly kill?: (signal?: string) => void } /** - * Worker node event detail. + * Worker node options. * * @internal */ -export interface WorkerNodeEventDetail { - workerId: number - workerNodeKey?: number +export interface WorkerNodeOptions { + workerOptions?: WorkerOptions + env?: Record + tasksQueueBackPressureSize: number } /** @@ -258,7 +286,7 @@ export interface IWorkerNode */ strategyData?: StrategyData /** - * Message channel (worker_threads only). + * Message channel (worker thread only). */ readonly messageChannel?: MessageChannel /** @@ -313,9 +341,37 @@ export interface IWorkerNode */ readonly resetUsage: () => void /** - * Closes communication channel. + * Terminates the worker node. + */ + readonly terminate: () => Promise + /** + * Registers a worker event handler. + * + * @param event - The event. + * @param handler - The event handler. */ - readonly closeChannel: () => void + readonly registerWorkerEventHandler: ( + event: string, + handler: + | OnlineHandler + | MessageHandler + | ErrorHandler + | ExitHandler + ) => void + /** + * Registers once a worker event handler. + * + * @param event - The event. + * @param handler - The event handler. + */ + readonly registerOnceWorkerEventHandler: ( + event: string, + handler: + | OnlineHandler + | MessageHandler + | ErrorHandler + | ExitHandler + ) => void /** * Gets task function worker usage statistics. * @@ -331,3 +387,13 @@ export interface IWorkerNode */ readonly deleteTaskFunctionWorkerUsage: (name: string) => boolean } + +/** + * Worker node event detail. + * + * @internal + */ +export interface WorkerNodeEventDetail { + workerId: number + workerNodeKey?: number +}