X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=b3e02f3ceb5ce8631848e65fcfcba871c4dd9e3c;hb=67e046a3e7a8a3c94dd1ff95252abe57f6819068;hp=0bdda982b16819ba1abdb65062c086e439344b97;hpb=db0e38eed9f8945c38ff579f5b33cb4bc44f62a1;p=poolifier.git

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index 0bdda982..b3e02f3c 100644
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -4,11 +4,15 @@ import type { Task } from '../utility-types'
 
 /**
  * Callback invoked when the worker has started successfully.
+ *
+ * @typeParam Worker - Type of worker.
  */
 export type OnlineHandler<Worker extends IWorker> = (this: Worker) => void
 
 /**
  * Callback invoked if the worker has received a message.
+ *
+ * @typeParam Worker - Type of worker.
  */
 export type MessageHandler<Worker extends IWorker> = (
   this: Worker,
@@ -17,6 +21,8 @@ export type MessageHandler<Worker extends IWorker> = (
 
 /**
  * Callback invoked if the worker raised an error.
+ *
+ * @typeParam Worker - Type of worker.
  */
 export type ErrorHandler<Worker extends IWorker> = (
   this: Worker,
@@ -25,6 +31,8 @@ export type ErrorHandler<Worker extends IWorker> = (
 
 /**
  * Callback invoked when the worker exits successfully.
+ *
+ * @typeParam Worker - Type of worker.
  */
 export type ExitHandler<Worker extends IWorker> = (
   this: Worker,
@@ -96,6 +104,10 @@ export interface TaskStatistics {
    * Maximum number of queued tasks.
    */
   readonly maxQueued?: number
+  /**
+   * Number of stolen tasks.
+   */
+  stolen: number
   /**
    * Number of failed tasks.
    */
@@ -128,7 +140,7 @@ export interface WorkerInfo {
   /**
    * Worker type.
    */
-  type: WorkerType
+  readonly type: WorkerType
   /**
    * Dynamic flag.
    */
@@ -140,7 +152,7 @@ export interface WorkerInfo {
   /**
    * Task function names.
    */
-  taskFunctions?: string[]
+  taskFunctionNames?: string[]
 }
 
 /**
@@ -167,6 +179,15 @@ export interface WorkerUsage {
   readonly elu: EventLoopUtilizationMeasurementStatistics
 }
 
+/**
+ * Worker choice strategy data.
+ *
+ * @internal
+ */
+export interface StrategyData {
+  virtualTaskEndTimestamp?: number
+}
+
 /**
  * Worker interface.
  */
@@ -189,12 +210,21 @@ export interface IWorker {
   /**
    * 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 detail.
+ *
+ * @internal
+ */
+export interface WorkerNodeEventDetail {
+  workerId: number
+}
+
 /**
  * Worker node interface.
  *
@@ -202,7 +232,8 @@ export interface IWorker {
  * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
  * @internal
  */
-export interface IWorkerNode<Worker extends IWorker, Data = unknown> {
+export interface IWorkerNode<Worker extends IWorker, Data = unknown>
+  extends EventTarget {
   /**
    * Worker.
    */
@@ -212,13 +243,23 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown> {
    */
   readonly info: WorkerInfo
   /**
-   * Message channel.
+   * Worker usage statistics.
+   */
+  readonly usage: WorkerUsage
+  /**
+   * Worker choice strategy data.
+   * This is used to store data that are specific to the worker choice strategy.
+   */
+  strategyData?: StrategyData
+  /**
+   * Message channel (worker_threads only).
    */
   readonly messageChannel?: MessageChannel
   /**
-   * Worker usage statistics.
+   * Tasks queue back pressure size.
+   * This is the number of tasks that can be enqueued before the worker node has back pressure.
    */
-  usage: WorkerUsage
+  tasksQueueBackPressureSize: number
   /**
    * Tasks queue size.
    *
@@ -229,15 +270,28 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown> {
    * Enqueue task.
    *
    * @param task - The task to queue.
-   * @returns The task queue size.
+   * @returns The tasks queue size.
    */
   readonly enqueueTask: (task: Task<Data>) => number
+  /**
+   * 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
+  /**
+   * Pops a task from the tasks queue.
+   *
+   * @returns The popped task.
+   */
+  readonly popTask: () => Task<Data> | undefined
   /**
    * Clears tasks queue.
    */
@@ -249,7 +303,7 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown> {
    */
   readonly hasBackPressure: () => boolean
   /**
-   * Resets usage statistics .
+   * Resets usage statistics.
    */
   readonly resetUsage: () => void
   /**
@@ -263,4 +317,11 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown> {
    * @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
 }