X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=41659adbdbec5b8d6b489d8dbfcb24f0820aff56;hb=b25a42cd89afca28b53dbecbec422595155ddfbc;hp=c92478d4a8436512853384f65ccce026f6528a19;hpb=f59e102739e13698f278f1d9d58ab26ed8150442;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index c92478d4..41659adb 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. @@ -37,6 +36,10 @@ export type ExitHandler = ( * @internal */ export interface Task { + /** + * Worker id. + */ + readonly workerId: number /** * Task name. */ @@ -64,19 +67,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 +96,9 @@ export interface MeasurementStatistics { * @internal */ export interface EventLoopUtilizationMeasurementStatistics { - idle: MeasurementStatistics - active: MeasurementStatistics - utilization: number + readonly idle: MeasurementStatistics + readonly active: MeasurementStatistics + utilization?: number } /** @@ -111,13 +122,26 @@ export interface TaskStatistics { /** * Maximum number of queued tasks. */ - readonly maxQueued: number + readonly maxQueued?: number /** * Number of failed tasks. */ 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. * @@ -125,13 +149,21 @@ export interface TaskStatistics { */ export interface WorkerInfo { /** - * Worker Id. + * Worker id. */ - id: number | undefined + readonly id: number | undefined /** - * Started flag. + * Worker type. */ - started: boolean + type: WorkerType + /** + * Dynamic flag. + */ + dynamic: boolean + /** + * Ready flag. + */ + ready: boolean } /** @@ -143,19 +175,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 } /** @@ -163,27 +195,27 @@ export interface WorkerUsage { */ export interface IWorker { /** - * Worker Id. + * Worker id. */ - id?: number - threadId?: number + readonly id?: number + readonly threadId?: number /** - * Register an event listener. + * 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 } /** @@ -193,7 +225,7 @@ 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. */ @@ -201,13 +233,40 @@ export interface WorkerNode { /** * Worker node worker info. */ - info: WorkerInfo + 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 resetUsage: () => void + /** + * Worker node get tasks usage statistics. */ - readonly tasksQueue: Queue> + readonly getTasksWorkerUsage: (name: string) => WorkerUsage | undefined }