X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=81b49d3bc4a0f02fb99f964b626fecae387c2d33;hb=658b9aa08266ed9a8ae3c0fc947d237fa2674f09;hp=86f5121dd1d73239c925c51319b6ff8bdc9b2a03;hpb=465b29401ecddad49070d3b0df4e55dc3902788c;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index 86f5121d..81b49d3b 100644 --- a/src/pools/worker.ts +++ b/src/pools/worker.ts @@ -1,5 +1,4 @@ import type { CircularArray } from '../circular-array' -import type { Queue } from '../queue' /** * Callback invoked if the worker has received a message. @@ -64,19 +63,27 @@ export interface MeasurementStatistics { /** * Measurement aggregate. */ - aggregate: number + aggregate?: number + /** + * Measurement minimum. + */ + minimum?: number + /** + * Measurement maximum. + */ + maximum?: number /** * Measurement average. */ - average: number + average?: number /** * Measurement median. */ - median: number + median?: number /** * Measurement history. */ - history: CircularArray + readonly history: CircularArray } /** @@ -85,9 +92,9 @@ export interface MeasurementStatistics { * @internal */ export interface EventLoopUtilizationMeasurementStatistics { - idle: MeasurementStatistics - active: MeasurementStatistics - utilization: number + readonly idle: MeasurementStatistics + readonly active: MeasurementStatistics + utilization?: number } /** @@ -118,6 +125,43 @@ export interface TaskStatistics { failed: number } +/** + * Enumeration of worker types. + */ +export const WorkerTypes = Object.freeze({ + cluster: 'cluster', + thread: 'thread' +} as const) + +/** + * Worker type. + */ +export type WorkerType = keyof typeof WorkerTypes + +/** + * Worker information. + * + * @internal + */ +export interface WorkerInfo { + /** + * Worker id. + */ + readonly id: number | undefined + /** + * Worker type. + */ + type: WorkerType + /** + * Dynamic flag. + */ + dynamic: boolean + /** + * Started flag. + */ + started: boolean +} + /** * Worker usage statistics. * @@ -127,19 +171,19 @@ export interface WorkerUsage { /** * Tasks statistics. */ - tasks: TaskStatistics + readonly tasks: TaskStatistics /** * Tasks runtime statistics. */ - runTime: MeasurementStatistics + readonly runTime: MeasurementStatistics /** * Tasks wait time statistics. */ - waitTime: MeasurementStatistics + readonly waitTime: MeasurementStatistics /** * Tasks event loop utilization statistics. */ - elu: EventLoopUtilizationMeasurementStatistics + readonly elu: EventLoopUtilizationMeasurementStatistics } /** @@ -147,22 +191,27 @@ 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. */ - on: ((event: 'message', handler: MessageHandler) => void) & + readonly on: ((event: 'message', handler: MessageHandler) => void) & ((event: 'error', handler: ErrorHandler) => void) & ((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. */ - once: (event: 'exit', handler: ExitHandler) => void + readonly once: (event: 'exit', handler: ExitHandler) => void } /** @@ -172,17 +221,44 @@ export interface IWorker { * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. * @internal */ -export interface WorkerNode { +export interface IWorkerNode { /** * Worker node worker. */ readonly worker: Worker + /** + * Worker node worker info. + */ + readonly info: WorkerInfo /** * Worker node worker usage statistics. */ usage: WorkerUsage /** - * Worker node tasks queue. + * Worker node tasks queue size. + * + * @returns The tasks queue size. + */ + readonly tasksQueueSize: () => number + /** + * Worker node enqueue task. + * + * @param task - The task to queue. + * @returns The task queue size. + */ + readonly enqueueTask: (task: Task) => number + /** + * Worker node dequeue task. + * + * @returns The dequeued task. + */ + readonly dequeueTask: () => Task | undefined + /** + * Worker node clear tasks queue. + */ + readonly clearTasksQueue: () => void + /** + * Worker node reset usage statistics . */ - readonly tasksQueue: Queue> + readonly resetUsage: () => void }