X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=58610eaaddacc2beea93809f80675bb8530010c0;hb=85003dff831b309b12d624215a8d67634af82b50;hp=93e4eda4c8e80aabfc1b13503e87ef4b0dc7173b;hpb=1c277f5889dcbfed65ca1862efba68198dcaa99c;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index 93e4eda4..58610eaa 100644 --- a/src/pools/worker.ts +++ b/src/pools/worker.ts @@ -1,5 +1,5 @@ import type { CircularArray } from '../circular-array' -import type { Queue } from '../queue' +import type { Task } from '../utility-types' /** * Callback invoked if the worker has received a message. @@ -31,48 +31,31 @@ export type ExitHandler = ( ) => void /** - * Message object that is passed as a task between main worker and worker. + * Measurement statistics. * - * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. * @internal */ -export interface Task { +export interface MeasurementStatistics { /** - * Task name. + * Measurement aggregate. */ - readonly name?: string + aggregate?: number /** - * Task input data that will be passed to the worker. + * Measurement minimum. */ - readonly data?: Data + minimum?: number /** - * Timestamp. + * Measurement maximum. */ - readonly timestamp?: number - /** - * Message UUID. - */ - readonly id?: string -} - -/** - * Measurement statistics. - * - * @internal - */ -export interface MeasurementStatistics { - /** - * Measurement aggregate. - */ - aggregate: number + maximum?: number /** * Measurement average. */ - average: number + average?: number /** * Measurement median. */ - median: number + median?: number /** * Measurement history. */ @@ -87,7 +70,7 @@ export interface MeasurementStatistics { export interface EventLoopUtilizationMeasurementStatistics { readonly idle: MeasurementStatistics readonly active: MeasurementStatistics - utilization: number + utilization?: number } /** @@ -111,13 +94,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. * @@ -129,13 +125,17 @@ export interface WorkerInfo { */ readonly id: number | undefined /** - * Started flag. + * Worker type. + */ + type: WorkerType + /** + * Dynamic flag. */ - started: boolean + dynamic: boolean /** - * Shared buffer. + * Ready flag. */ - readonly sharedBuffer?: Int32Array + ready: boolean } /** @@ -177,7 +177,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) @@ -187,7 +187,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 } /** @@ -197,21 +197,48 @@ 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. + * Worker. */ readonly worker: Worker /** - * Worker node worker info. + * Worker info. */ readonly info: WorkerInfo /** - * Worker node worker usage statistics. + * Worker usage statistics. */ usage: WorkerUsage /** - * Worker node tasks queue. + * Tasks queue size. + * + * @returns The tasks queue size. + */ + readonly tasksQueueSize: () => number + /** + * Enqueue task. + * + * @param task - The task to queue. + * @returns The task queue size. + */ + readonly enqueueTask: (task: Task) => number + /** + * Dequeue task. + * + * @returns The dequeued task. + */ + readonly dequeueTask: () => Task | undefined + /** + * Clears tasks queue. + */ + readonly clearTasksQueue: () => void + /** + * Resets usage statistics . + */ + readonly resetUsage: () => void + /** + * Gets task usage statistics. */ - readonly tasksQueue: Queue> + readonly getTaskWorkerUsage: (name: string) => WorkerUsage | undefined }