refactor: remove unused queue code

[poolifier.git] / src / pools / worker.ts

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index 3c44f05eae148883c5c83f91304f894d2297e5fc..6b387a96088d430d455ed0a4dbb3759c1cbbe86e 100644 (file)
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -212,13 +212,24 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown> {
    */
   readonly info: WorkerInfo
   /**
-   * Message channel.
+   * Message channel (worker_threads only).
    */
   readonly messageChannel?: MessageChannel
   /**
    * Worker usage statistics.
    */
   usage: WorkerUsage
+  /**
+   * 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.
+   *
+   * @param workerId - The worker id.
+   */
+  onBackPressure?: (workerId: number) => void
   /**
    * Tasks queue size.
    *
@@ -229,27 +240,40 @@ 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.
    */
   readonly clearTasksQueue: () => void
   /**
-   * Whether the worker node has back pressure.
+   * 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 .
+   * Resets usage statistics.
    */
   readonly resetUsage: () => void
   /**
@@ -262,5 +286,5 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown> {
    * @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 getTaskWorkerUsage: (name: string) => WorkerUsage | undefined
+  readonly getTaskFunctionWorkerUsage: (name: string) => WorkerUsage | undefined
 }