X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=5ac90fbf1783e9e04a7e820e37c961e8527385ff;hb=b558f6b5a5625753de41024325e40e1cbd03eda1;hp=c6303221c9d2da4badc9af17ac6e8a80fda27d98;hpb=21f710aa73abbb5d90328cfb199adfc0f7a70406;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index c6303221..5ac90fbf 100644 --- a/src/pools/worker.ts +++ b/src/pools/worker.ts @@ -1,4 +1,6 @@ +import type { MessageChannel } from 'node:worker_threads' import type { CircularArray } from '../circular-array' +import type { Task } from '../utility-types' /** * Callback invoked if the worker has received a message. @@ -29,35 +31,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 { - /** - * Worker id. - */ - readonly workerId: number - /** - * 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. * @@ -122,7 +95,7 @@ export interface TaskStatistics { /** * Maximum number of queued tasks. */ - readonly maxQueued: number + readonly maxQueued?: number /** * Number of failed tasks. */ @@ -133,8 +106,8 @@ export interface TaskStatistics { * Enumeration of worker types. */ export const WorkerTypes = Object.freeze({ - cluster: 'cluster', - thread: 'thread' + thread: 'thread', + cluster: 'cluster' } as const) /** @@ -164,6 +137,14 @@ export interface WorkerInfo { * Ready flag. */ ready: boolean + /** + * Task function names. + */ + taskFunctions?: string[] + /** + * Message channel. + */ + messageChannel?: MessageChannel } /** @@ -205,9 +186,9 @@ export interface IWorker { * @param event - The event. * @param handler - The event handler. */ - readonly on: ((event: 'message', handler: MessageHandler) => void) & + readonly on: ((event: 'online', handler: OnlineHandler) => void) & + ((event: 'message', handler: MessageHandler) => void) & ((event: 'error', handler: ErrorHandler) => void) & - ((event: 'online', handler: OnlineHandler) => void) & ((event: 'exit', handler: ExitHandler) => void) /** * Registers a listener to the exit event that will only be performed once. @@ -227,42 +208,50 @@ export interface IWorker { */ 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 size. + * Tasks queue size. * * @returns The tasks queue size. */ readonly tasksQueueSize: () => number /** - * Worker node enqueue task. + * Enqueue task. * * @param task - The task to queue. * @returns The task queue size. */ readonly enqueueTask: (task: Task) => number /** - * Worker node dequeue task. + * Dequeue task. * * @returns The dequeued task. */ readonly dequeueTask: () => Task | undefined /** - * Worker node clear tasks queue. + * Clears tasks queue. */ readonly clearTasksQueue: () => void /** - * Worker node reset usage statistics . + * Resets usage statistics . */ readonly resetUsage: () => void + /** + * Close communication channel. + */ + readonly closeChannel: () => void + /** + * Gets task worker usage statistics. + */ + readonly getTaskWorkerUsage: (name: string) => WorkerUsage | undefined }