X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=c6303221c9d2da4badc9af17ac6e8a80fda27d98;hb=refs%2Ftags%2Fv2.6.10;hp=35853b7dcf427b8281d65b74399106707b930577;hpb=2845f2a5555247bbc4e5f6f1059d4f95405a49cd;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index 35853b7d..c6303221 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,23 +67,23 @@ export interface MeasurementStatistics { /** * Measurement aggregate. */ - aggregate: number + aggregate?: number /** * Measurement minimum. */ - minimum: number + minimum?: number /** * Measurement maximum. */ - maximum: number + maximum?: number /** * Measurement average. */ - average: number + average?: number /** * Measurement median. */ - median: number + median?: number /** * Measurement history. */ @@ -126,6 +129,19 @@ 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. * @@ -136,14 +152,18 @@ export interface WorkerInfo { * Worker id. */ readonly id: number | undefined + /** + * Worker type. + */ + type: WorkerType /** * Dynamic flag. */ dynamic: boolean /** - * Started flag. + * Ready flag. */ - started: boolean + ready: boolean } /** @@ -185,7 +205,7 @@ export interface IWorker { * @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) @@ -195,7 +215,7 @@ export interface IWorker { * @param event - `'exit'`. * @param handler - The exit handler. */ - once: (event: 'exit', handler: ExitHandler) => void + readonly once: (event: 'exit', handler: ExitHandler) => void } /** @@ -205,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. */ @@ -219,7 +239,30 @@ export interface WorkerNode { */ 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 }