X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=9a27d8a5056bb7b4b222f2d210803699ab95ad0d;hb=839b98b8d7b2a142da0841e9618b14c3e4e55c71;hp=b3e02f3ceb5ce8631848e65fcfcba871c4dd9e3c;hpb=09b75fef0162fa1a333d3c61c6da735b771ed801;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index b3e02f3c..9a27d8a5 100644 --- a/src/pools/worker.ts +++ b/src/pools/worker.ts @@ -1,4 +1,5 @@ -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' @@ -104,6 +105,10 @@ export interface TaskStatistics { * Maximum number of queued tasks. */ readonly maxQueued?: number + /** + * Number of sequentially stolen tasks. + */ + sequentiallyStolen: number /** * Number of stolen tasks. */ @@ -193,36 +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 once: (event: 'exit', handler: ExitHandler) => void + readonly terminate?: () => Promise + /** + * Cluster worker disconnect. + */ + readonly disconnect?: () => void + /** + * Cluster worker kill. + */ + readonly kill?: (signal?: string) => void } /** - * Worker node event detail. + * Worker node options. * * @internal */ -export interface WorkerNodeEventDetail { - workerId: number +export interface WorkerNodeOptions { + workerOptions?: WorkerOptions + env?: Record + tasksQueueBackPressureSize: number } /** @@ -233,7 +267,7 @@ export interface WorkerNodeEventDetail { * @internal */ export interface IWorkerNode - extends EventTarget { + extends EventEmitter { /** * Worker. */ @@ -252,7 +286,7 @@ export interface IWorkerNode */ strategyData?: StrategyData /** - * Message channel (worker_threads only). + * Message channel (worker thread only). */ readonly messageChannel?: MessageChannel /** @@ -307,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 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 closeChannel: () => void + readonly registerOnceWorkerEventHandler: ( + event: string, + handler: + | OnlineHandler + | MessageHandler + | ErrorHandler + | ExitHandler + ) => void /** * Gets task function worker usage statistics. * @@ -325,3 +387,13 @@ export interface IWorkerNode */ readonly deleteTaskFunctionWorkerUsage: (name: string) => boolean } + +/** + * Worker node event detail. + * + * @internal + */ +export interface WorkerNodeEventDetail { + workerId: number + workerNodeKey?: number +}