X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=664b6a7695ef42a088732812a7eac270e9f87a00;hb=7ae6fb74fef4b3a2491d3d56293914fe5243c0d2;hp=4d935a113336921a5f49e6858046b07a863096fd;hpb=a4e07f7216246b772e13783937a97c87105b8fc3;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index 4d935a11..664b6a76 100644 --- a/src/pools/worker.ts +++ b/src/pools/worker.ts @@ -1,4 +1,3 @@ -import type { EventLoopUtilization } from 'node:perf_hooks' import type { CircularArray } from '../circular-array' import type { Queue } from '../queue' @@ -7,7 +6,7 @@ import type { Queue } from '../queue' */ export type MessageHandler = ( this: Worker, - m: unknown + message: unknown ) => void /** @@ -15,7 +14,7 @@ export type MessageHandler = ( */ export type ErrorHandler = ( this: Worker, - e: Error + error: Error ) => void /** @@ -28,13 +27,13 @@ export type OnlineHandler = (this: Worker) => void */ export type ExitHandler = ( this: Worker, - code: number + exitCode: number ) => void /** * Message object that is passed as a task between main worker and worker. * - * @typeParam Data - Type of data sent to the worker. This can only be serializable data. + * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. * @internal */ export interface Task { @@ -57,54 +56,84 @@ export interface Task { } /** - * Measure statistics. + * Measurement statistics. * * @internal */ -export interface MeasureStatistics { +export interface MeasurementStatistics { /** - * Measure aggregation. + * Measurement aggregate. */ - aggregation: number + aggregate: number /** - * Measure average. + * Measurement average. */ average: number /** - * Measure median. + * Measurement median. */ median: number /** - * Measure history. + * Measurement history. */ history: CircularArray } /** - * Task statistics. + * Event loop utilization measurement statistics. * * @internal */ +export interface EventLoopUtilizationMeasurementStatistics { + idle: MeasurementStatistics + active: MeasurementStatistics + utilization: number +} +/** + * Task statistics. + * + * @internal + */ export interface TaskStatistics { /** - * Number of tasks executed. + * Number of executed tasks. */ executed: number /** - * Number of tasks executing. + * Number of executing tasks. */ executing: number /** - * Number of tasks queued. + * Number of queued tasks. + */ + readonly queued: number + /** + * Maximum number of queued tasks. */ - queued: number + readonly maxQueued: number /** - * Number of tasks failed. + * Number of failed tasks. */ failed: number } +/** + * Worker information. + * + * @internal + */ +export interface WorkerInfo { + /** + * Worker id. + */ + id: number | undefined + /** + * Started flag. + */ + started: boolean +} + /** * Worker usage statistics. * @@ -118,15 +147,15 @@ export interface WorkerUsage { /** * Tasks runtime statistics. */ - runTime: MeasureStatistics + runTime: MeasurementStatistics /** * Tasks wait time statistics. */ - waitTime: MeasureStatistics + waitTime: MeasurementStatistics /** - * Event loop utilization. + * Tasks event loop utilization statistics. */ - elu: EventLoopUtilization | undefined + elu: EventLoopUtilizationMeasurementStatistics } /** @@ -134,7 +163,12 @@ export interface WorkerUsage { */ export interface IWorker { /** - * Register an event listener. + * Worker id. + */ + readonly id?: number + readonly threadId?: number + /** + * Registers an event listener. * * @param event - The event. * @param handler - The event handler. @@ -144,7 +178,7 @@ export interface IWorker { ((event: 'online', handler: OnlineHandler) => void) & ((event: 'exit', handler: ExitHandler) => void) /** - * Register a listener to the exit event that will only be performed once. + * Registers a listener to the exit event that will only be performed once. * * @param event - `'exit'`. * @param handler - The exit handler. @@ -156,7 +190,7 @@ export interface IWorker { * Worker node interface. * * @typeParam Worker - Type of worker. - * @typeParam Data - Type of data sent to the worker. This can only be serializable data. + * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. * @internal */ export interface WorkerNode { @@ -164,10 +198,14 @@ export interface WorkerNode { * Worker node worker. */ readonly worker: Worker + /** + * Worker node worker info. + */ + info: WorkerInfo /** * Worker node worker usage statistics. */ - workerUsage: WorkerUsage + usage: WorkerUsage /** * Worker node tasks queue. */