chore: v4.0.12
[poolifier.git] / src / pools / worker.ts
index ac6718fb33c9bdfa065967e4a7da112d42e47888..b2e6ba80198480f0edfe72e45c5eee56f80d03f7 100644 (file)
@@ -1,7 +1,7 @@
 import type { EventEmitter } from 'node:events'
 import type { MessageChannel, WorkerOptions } from 'node:worker_threads'
 
-import type { CircularArray } from '../circular-array.js'
+import type { CircularBuffer } from '../circular-buffer.js'
 import type { Task, TaskFunctionProperties } from '../utility-types.js'
 
 /**
@@ -52,6 +52,11 @@ export type EventHandler<Worker extends IWorker> =
   | ErrorHandler<Worker>
   | ExitHandler<Worker>
 
+/**
+ * Measurement history size.
+ */
+export const MeasurementHistorySize = 386
+
 /**
  * Measurement statistics.
  *
@@ -81,7 +86,7 @@ export interface MeasurementStatistics {
   /**
    * Measurement history.
    */
-  readonly history: CircularArray<number>
+  readonly history: CircularBuffer
 }
 
 /**
@@ -172,6 +177,11 @@ export interface WorkerInfo {
    * This flag is set to `true` when worker node is stealing tasks from another worker node.
    */
   stealing: boolean
+  /**
+   * Back pressure flag.
+   * This flag is set to `true` when worker node tasks queue has back pressure.
+   */
+  backPressure: boolean
   /**
    * Task functions properties.
    */
@@ -267,6 +277,7 @@ export interface WorkerNodeOptions {
   workerOptions?: WorkerOptions
   env?: Record<string, unknown>
   tasksQueueBackPressureSize: number | undefined
+  tasksQueueBucketSize: number | undefined
 }
 
 /**
@@ -317,25 +328,19 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown>
    * @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.
    *
+   * @param bucket - The prioritized bucket to dequeue from. @defaultValue 0
    * @returns The dequeued task.
    */
-  readonly dequeueTask: () => Task<Data> | undefined
+  readonly dequeueTask: (bucket?: number) => Task<Data> | undefined
   /**
-   * Pops a task from the tasks queue.
+   * Dequeue last prioritized task.
    *
-   * @returns The popped task.
+   * @returns The dequeued task.
    */
-  readonly popTask: () => Task<Data> | undefined
+  readonly dequeueLastPrioritizedTask: () => Task<Data> | undefined
   /**
    * Clears tasks queue.
    */
@@ -346,10 +351,6 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown>
    * @returns `true` if the worker node has back pressure, `false` otherwise.
    */
   readonly hasBackPressure: () => boolean
-  /**
-   * Resets usage statistics.
-   */
-  readonly resetUsage: () => void
   /**
    * Terminates the worker node.
    */