X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=4c877bc8b1dcc58871a55cd70c87871d918c4596;hb=refs%2Ftags%2Fv2.7.4;hp=7a8c59e7730eba9be39ae972f94022a8a65a14ce;hpb=ec287edfc71369699efd04e284db8759ace8a59c;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index 7a8c59e7..4c877bc8 100644 --- a/src/pools/worker.ts +++ b/src/pools/worker.ts @@ -132,7 +132,7 @@ export interface WorkerInfo { /** * Worker type. */ - type: WorkerType + readonly type: WorkerType /** * Dynamic flag. */ @@ -144,7 +144,7 @@ export interface WorkerInfo { /** * Task function names. */ - taskFunctions?: string[] + taskFunctionNames?: string[] } /** @@ -171,6 +171,15 @@ export interface WorkerUsage { readonly elu: EventLoopUtilizationMeasurementStatistics } +/** + * Worker choice strategy data. + * + * @internal + */ +export interface StrategyData { + virtualTaskEndTimestamp?: number +} + /** * Worker interface. */ @@ -199,8 +208,13 @@ export interface IWorker { readonly once: (event: 'exit', handler: ExitHandler) => void } -export type EmptyQueueCallback = (workerId: number) => void -export type BackPressureCallback = EmptyQueueCallback +/** + * Worker node event callback. + * + * @param workerId - The worker id. + * @internal + */ +export type WorkerNodeEventCallback = (workerId: number) => void /** * Worker node interface. @@ -221,7 +235,12 @@ export interface IWorkerNode { /** * Worker usage statistics. */ - usage: WorkerUsage + readonly usage: WorkerUsage + /** + * Worker choice strategy data. + * This is used to store data that is specific to the worker choice strategy. + */ + strategyData?: StrategyData /** * Message channel (worker_threads only). */ @@ -233,16 +252,12 @@ export interface IWorkerNode { tasksQueueBackPressureSize: number /** * Callback invoked when worker node tasks queue is back pressured. - * - * @param workerId - The worker id. */ - onBackPressure?: EmptyQueueCallback + onBackPressure?: WorkerNodeEventCallback /** * Callback invoked when worker node tasks queue is empty. - * - * @param workerId - The worker id. */ - onEmptyQueue?: BackPressureCallback + onEmptyQueue?: WorkerNodeEventCallback /** * Tasks queue size. * @@ -300,4 +315,11 @@ export interface IWorkerNode { * @returns The task function worker usage statistics if the task function worker usage statistics are initialized, `undefined` otherwise. */ readonly getTaskFunctionWorkerUsage: (name: string) => WorkerUsage | undefined + /** + * Deletes task function worker usage statistics. + * + * @param name - The task function name. + * @returns `true` if the task function worker usage statistics were deleted, `false` otherwise. + */ + readonly deleteTaskFunctionWorkerUsage: (name: string) => boolean }