X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=58610eaaddacc2beea93809f80675bb8530010c0;hb=5c4d16da7677746e563fdcfe7f82cbb842d1c9e6;hp=7f9cef0a6632aa354f07eb04db5dea6d7ad38c4e;hpb=f751010550f07200428ca708afb2ec1d242cf7a7;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index 7f9cef0a..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. @@ -30,31 +30,6 @@ export type ExitHandler = ( 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 structured-cloneable data. - * @internal - */ -export interface Task { - /** - * Task name. - */ - readonly name?: string - /** - * Task input data that will be passed to the worker. - */ - readonly data?: Data - /** - * Timestamp. - */ - readonly timestamp?: number - /** - * Message UUID. - */ - readonly id?: string -} - /** * Measurement statistics. * @@ -64,23 +39,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. */ @@ -119,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. * @@ -137,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 } /** @@ -185,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) @@ -195,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 } /** @@ -205,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 }