X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Futility-types.ts;h=82f79230accb88160ae612e9d5cc5ba7da57d157;hb=db22961e5cfde777a2b2e8faf9e6dc2919b33eda;hp=b2470bea17df1e283ee492a4346f46bf6944a13f;hpb=71cad0b00456d2f7cf0987604062674ff19b44c4;p=poolifier.git diff --git a/src/utility-types.ts b/src/utility-types.ts index b2470bea..82f79230 100644 --- a/src/utility-types.ts +++ b/src/utility-types.ts @@ -1,6 +1,9 @@ +import type { AsyncResource } from 'node:async_hooks' import type { EventLoopUtilization } from 'node:perf_hooks' import type { MessagePort, TransferListItem } from 'node:worker_threads' -import type { KillBehavior } from './worker/worker-options' + +import type { WorkerChoiceStrategy } from './pools/selection-strategies/selection-strategies-types.js' +import type { KillBehavior } from './worker/worker-options.js' /** * Worker error. @@ -62,6 +65,24 @@ export interface WorkerStatistics { readonly elu: boolean } +/** + * Task function properties. + */ +export interface TaskFunctionProperties { + /** + * Task function name. + */ + readonly name: string + /** + * Task function priority. Lower values have higher priority. + */ + readonly priority?: number + /** + * Task function worker choice strategy. + */ + readonly strategy?: WorkerChoiceStrategy +} + /** * Message object that is passed as a task between main worker and worker. * @@ -69,10 +90,6 @@ export interface WorkerStatistics { * @internal */ export interface Task { - /** - * Worker id. - */ - readonly workerId: number /** * Task name. */ @@ -81,10 +98,20 @@ export interface Task { * Task input data that will be passed to the worker. */ readonly data?: Data + /** + * Task priority. Lower values have higher priority. + * + * @defaultValue 0 + */ + readonly priority?: number + /** + * Task worker choice strategy. + */ + readonly strategy?: WorkerChoiceStrategy /** * Array of transferable objects. */ - readonly transferList?: TransferListItem[] + readonly transferList?: readonly TransferListItem[] /** * Timestamp. */ @@ -92,7 +119,7 @@ export interface Task { /** * Task UUID. */ - readonly taskId?: string + readonly taskId?: `${string}-${string}-${string}-${string}-${string}` } /** @@ -104,6 +131,10 @@ export interface Task { */ export interface MessageValue extends Task { + /** + * Worker id. + */ + readonly workerId?: number /** * Kill code. */ @@ -118,25 +149,27 @@ export interface MessageValue readonly taskPerformance?: TaskPerformance /** * Task function operation: - * - `'has'` - Check if a task function exists. * - `'add'` - Add a task function. - * - `'delete'` - Delete a task function. + * - `'remove'` - Remove a task function. * - `'default'` - Set a task function as default. */ - readonly taskFunctionOperation?: 'has' | 'add' | 'remove' | 'default' + readonly taskFunctionOperation?: 'add' | 'remove' | 'default' + /** + * Whether the task function operation is successful or not. + */ readonly taskFunctionOperationStatus?: boolean /** - * Task function serialized to string. + * Task function properties. */ - readonly taskFunction?: string + readonly taskFunctionProperties?: TaskFunctionProperties /** - * Task function name. + * Task function serialized to string. */ - readonly taskFunctionName?: string + readonly taskFunction?: string /** - * Task function names. + * Task functions properties. */ - readonly taskFunctionNames?: string[] + readonly taskFunctionsProperties?: TaskFunctionProperties[] /** * Whether the worker computes the given statistics or not. */ @@ -174,6 +207,10 @@ export interface PromiseResponseWrapper { * The worker node key executing the task. */ readonly workerNodeKey: number + /** + * The asynchronous resource used to track the task execution. + */ + readonly asyncResource?: AsyncResource } export type Writable = { -readonly [P in keyof T]: T[P] }