X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=a418ee885f903d3bb9838c0c34be0e6bbce43524;hb=46e29227a97fe04f886969199f1c14338af50543;hp=1eb8df50ed527bf80eeff0eebee1721fe7e7f0c4;hpb=465b29401ecddad49070d3b0df4e55dc3902788c;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index 1eb8df50..a418ee88 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,6 +1,6 @@ import type { EventLoopUtilization } from 'node:perf_hooks' +import type { MessagePort, TransferListItem } from 'node:worker_threads' import type { KillBehavior } from './worker/worker-options' -import type { IWorker, Task } from './pools/worker' /** * Task error. @@ -8,42 +8,87 @@ import type { IWorker, Task } from './pools/worker' * @typeParam Data - Type of data sent to the worker triggering an error. This can only be structured-cloneable data. */ export interface TaskError { + /** + * Task name triggering the error. + */ + readonly name: string /** * Error message. */ - message: string + readonly message: string /** - * Data passed to the worker triggering the error. + * Data triggering the error. */ - data?: Data + readonly data?: Data } /** * Task performance. + * + * @internal */ export interface TaskPerformance { + /** + * Task name. + */ + readonly name: string /** * Task performance timestamp. */ - timestamp: number + readonly timestamp: number /** * Task runtime. */ - runTime?: number + readonly runTime?: number /** * Task event loop utilization. */ - elu?: EventLoopUtilization + readonly elu?: EventLoopUtilization } /** * Performance statistics computation. + * + * @internal */ export interface WorkerStatistics { runTime: boolean elu: boolean } +/** + * 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 + /** + * Array of transferable objects. + */ + readonly transferList?: TransferListItem[] + /** + * Timestamp. + */ + readonly timestamp?: number + /** + * Task UUID. + */ + readonly taskId?: string +} + /** * Message object that is passed between main worker and worker. * @@ -56,7 +101,7 @@ export interface MessageValue /** * Kill code. */ - readonly kill?: KillBehavior | 1 + readonly kill?: KillBehavior | true | 'success' | 'failure' /** * Task error. */ @@ -65,33 +110,45 @@ export interface MessageValue * Task performance. */ readonly taskPerformance?: TaskPerformance + /** + * Task function names. + */ + readonly taskFunctions?: string[] /** * Whether the worker computes the given statistics or not. */ readonly statistics?: WorkerStatistics + /** + * Whether the worker is ready or not. + */ + readonly ready?: boolean + /** + * Whether the worker starts or stops its activity check. + */ + readonly checkActive?: boolean + /** + * Message port. + */ + readonly port?: MessagePort } /** - * An object holding the execution response promise resolve/reject callbacks. + * An object holding the task execution response promise resolve/reject callbacks. * - * @typeParam Worker - Type of worker. * @typeParam Response - Type of execution response. This can only be structured-cloneable data. * @internal */ -export interface PromiseResponseWrapper< - Worker extends IWorker, - Response = unknown -> { +export interface PromiseResponseWrapper { /** * Resolve callback to fulfill the promise. */ - readonly resolve: (value: Response) => void + readonly resolve: (value: Response | PromiseLike) => void /** * Reject callback to reject the promise. */ - readonly reject: (reason?: string) => void + readonly reject: (reason?: unknown) => void /** - * The worker handling the execution. + * The worker node key executing the task. */ - readonly worker: Worker + readonly workerNodeKey: number }