X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=7f8148ffcc93db670479a9ce5d7c96b6e576a1d0;hb=cdaecaee1c7fa5c412daf29f2db41470506793ac;hp=776986d5000f2c2d33cdf8f9daf444038df74ef6;hpb=463226a44b0370911db746052bcad0bcc7878acf;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index 776986d5..7f8148ff 100644 --- a/src/pools/worker.ts +++ b/src/pools/worker.ts @@ -1,6 +1,7 @@ -import type { MessageChannel } from 'node:worker_threads' -import type { CircularArray } from '../circular-array' -import type { Task } from '../utility-types' +import type { MessageChannel, WorkerOptions } from 'node:worker_threads' +import type { EventEmitter } from 'node:events' +import type { CircularArray } from '../circular-array.js' +import type { Task } from '../utility-types.js' /** * Callback invoked when the worker has started successfully. @@ -39,6 +40,17 @@ export type ExitHandler = ( exitCode: number ) => void +/** + * Worker event handler. + * + * @typeParam Worker - Type of worker. + */ +export type EventHandler = + | OnlineHandler + | MessageHandler + | ErrorHandler + | ExitHandler + /** * Measurement statistics. * @@ -153,6 +165,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. */ @@ -197,37 +214,51 @@ 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: EventHandler) => 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: EventHandler) => 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 | undefined } /** @@ -238,7 +269,7 @@ export interface WorkerNodeEventDetail { * @internal */ export interface IWorkerNode - extends EventTarget { + extends EventEmitter { /** * Worker. */ @@ -257,7 +288,7 @@ export interface IWorkerNode */ strategyData?: StrategyData /** - * Message channel (worker_threads only). + * Message channel (worker thread only). */ readonly messageChannel?: MessageChannel /** @@ -312,9 +343,29 @@ 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: EventHandler + ) => void + /** + * Registers once a worker event handler. + * + * @param event - The event. + * @param handler - The event handler. */ - readonly closeChannel: () => void + readonly registerOnceWorkerEventHandler: ( + event: string, + handler: EventHandler + ) => void /** * Gets task function worker usage statistics. * @@ -330,3 +381,13 @@ export interface IWorkerNode */ readonly deleteTaskFunctionWorkerUsage: (name: string) => boolean } + +/** + * Worker node event detail. + * + * @internal + */ +export interface WorkerNodeEventDetail { + workerId: number + workerNodeKey?: number +}