+import type { MessageChannel } from 'node:worker_threads'
import type { CircularArray } from '../circular-array'
+import type { Task } from '../utility-types'
+
+/**
+ * Callback invoked when the worker has started successfully.
+ */
+export type OnlineHandler<Worker extends IWorker> = (this: Worker) => void
/**
* Callback invoked if the worker has received a message.
error: Error
) => void
-/**
- * Callback invoked when the worker has started successfully.
- */
-export type OnlineHandler<Worker extends IWorker> = (this: Worker) => void
-
/**
* Callback invoked when the worker exits successfully.
*/
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<Data = unknown> {
- /**
- * 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.
*
/**
* Maximum number of queued tasks.
*/
- readonly maxQueued: number
+ readonly maxQueued?: number
+ /**
+ * Number of stolen tasks.
+ */
+ stolen: number
/**
* Number of failed tasks.
*/
* Enumeration of worker types.
*/
export const WorkerTypes = Object.freeze({
- cluster: 'cluster',
- thread: 'thread'
+ thread: 'thread',
+ cluster: 'cluster'
} as const)
/**
/**
* Worker type.
*/
- type: WorkerType
+ readonly type: WorkerType
/**
* Dynamic flag.
*/
* Ready flag.
*/
ready: boolean
+ /**
+ * Task function names.
+ */
+ taskFunctions?: string[]
}
/**
readonly elu: EventLoopUtilizationMeasurementStatistics
}
+/**
+ * Worker choice strategy data.
+ *
+ * @internal
+ */
+export interface StrategyData {
+ virtualTaskEndTimestamp?: number
+}
+
/**
* Worker interface.
*/
* @param event - The event.
* @param handler - The event handler.
*/
- readonly on: ((event: 'message', handler: MessageHandler<this>) => void) &
+ readonly on: ((event: 'online', handler: OnlineHandler<this>) => void) &
+ ((event: 'message', handler: MessageHandler<this>) => void) &
((event: 'error', handler: ErrorHandler<this>) => void) &
- ((event: 'online', handler: OnlineHandler<this>) => void) &
((event: 'exit', handler: ExitHandler<this>) => void)
/**
* Registers a listener to the exit event that will only be performed once.
*
- * @param event - `'exit'`.
+ * @param event - The `'exit'` event.
* @param handler - The exit handler.
*/
readonly once: (event: 'exit', handler: ExitHandler<this>) => void
}
+/**
+ * Worker node event callback.
+ *
+ * @param workerId - The worker id.
+ * @internal
+ */
+export type WorkerNodeEventCallback = (workerId: number) => void
+
/**
* Worker node interface.
*
*/
export interface IWorkerNode<Worker extends IWorker, Data = unknown> {
/**
- * Worker node worker.
+ * Worker.
*/
readonly worker: Worker
/**
- * Worker node worker info.
+ * Worker info.
*/
readonly info: WorkerInfo
/**
- * Worker node worker usage statistics.
+ * Worker usage statistics.
+ */
+ 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).
+ */
+ readonly messageChannel?: MessageChannel
+ /**
+ * Tasks queue back pressure size.
+ * This is the number of tasks that can be enqueued before the worker node has back pressure.
+ */
+ tasksQueueBackPressureSize: number
+ /**
+ * Callback invoked when worker node tasks queue is back pressured.
*/
- usage: WorkerUsage
+ onBackPressure?: WorkerNodeEventCallback
/**
- * Worker node tasks queue size.
+ * Callback invoked when worker node tasks queue is empty.
+ */
+ onEmptyQueue?: WorkerNodeEventCallback
+ /**
+ * 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.
+ * @returns The tasks queue size.
*/
readonly enqueueTask: (task: Task<Data>) => number
/**
- * Worker node dequeue task.
+ * Prepends a task to the tasks queue.
+ *
+ * @param task - The task to prepend.
+ * @returns The tasks queue size.
+ */
+ readonly unshiftTask: (task: Task<Data>) => number
+ /**
+ * Dequeue task.
*
* @returns The dequeued task.
*/
readonly dequeueTask: () => Task<Data> | undefined
/**
- * Worker node clear tasks queue.
+ * Pops a task from the tasks queue.
+ *
+ * @returns The popped task.
+ */
+ readonly popTask: () => Task<Data> | undefined
+ /**
+ * Clears tasks queue.
*/
readonly clearTasksQueue: () => void
/**
- * Worker node reset usage statistics .
+ * Whether the worker node has back pressure (i.e. its tasks queue is full).
+ *
+ * @returns `true` if the worker node has back pressure, `false` otherwise.
+ */
+ readonly hasBackPressure: () => boolean
+ /**
+ * Resets usage statistics.
*/
readonly resetUsage: () => void
/**
- * Worker node get tasks usage statistics.
+ * Closes communication channel.
+ */
+ readonly closeChannel: () => void
+ /**
+ * Gets task function worker usage statistics.
+ *
+ * @param name - The task function name.
+ * @returns The task function worker usage statistics if the task function worker usage statistics are initialized, `undefined` otherwise.
*/
- readonly getTasksWorkerUsage: (name: string) => WorkerUsage | undefined
+ readonly getTaskFunctionWorkerUsage: (name: string) => WorkerUsage | undefined
}