X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=664b6a7695ef42a088732812a7eac270e9f87a00;hb=7ae6fb74fef4b3a2491d3d56293914fe5243c0d2;hp=598e6be82ca22588c34f04d6a0c402359956b66d;hpb=5df69fabd77b3ec4137a6382e2d84791bf0fe85d;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index 598e6be8..664b6a76 100644 --- a/src/pools/worker.ts +++ b/src/pools/worker.ts @@ -6,7 +6,7 @@ import type { Queue } from '../queue' */ export type MessageHandler = ( this: Worker, - m: unknown + message: unknown ) => void /** @@ -14,7 +14,7 @@ export type MessageHandler = ( */ export type ErrorHandler = ( this: Worker, - e: Error + error: Error ) => void /** @@ -27,13 +27,13 @@ export type OnlineHandler = (this: Worker) => void */ export type ExitHandler = ( this: Worker, - code: number + 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 serializable data. + * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. * @internal */ export interface Task { @@ -108,12 +108,32 @@ export interface TaskStatistics { * Number of queued tasks. */ readonly queued: number + /** + * Maximum number of queued tasks. + */ + readonly maxQueued: number /** * Number of failed tasks. */ failed: number } +/** + * Worker information. + * + * @internal + */ +export interface WorkerInfo { + /** + * Worker id. + */ + id: number | undefined + /** + * Started flag. + */ + started: boolean +} + /** * Worker usage statistics. * @@ -143,7 +163,12 @@ export interface WorkerUsage { */ export interface IWorker { /** - * Register an event listener. + * Worker id. + */ + readonly id?: number + readonly threadId?: number + /** + * Registers an event listener. * * @param event - The event. * @param handler - The event handler. @@ -153,7 +178,7 @@ export interface IWorker { ((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. @@ -165,7 +190,7 @@ export interface IWorker { * Worker node interface. * * @typeParam Worker - Type of worker. - * @typeParam Data - Type of data sent to the worker. This can only be serializable data. + * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. * @internal */ export interface WorkerNode { @@ -173,10 +198,14 @@ export interface WorkerNode { * Worker node worker. */ readonly worker: Worker + /** + * Worker node worker info. + */ + info: WorkerInfo /** * Worker node worker usage statistics. */ - workerUsage: WorkerUsage + usage: WorkerUsage /** * Worker node tasks queue. */