X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=99c0d9a6feeea35815a520ff95a160d927bcc4fc;hb=c4d1efd35b3963f0e251df2b220a850d7afa8a69;hp=9c8b77fc623b68ed2a25aed883531dfa5e25cf70;hpb=f8b3d84c1c95773a1e18d2c025d89d73c4f2ab15;p=poolifier.git

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index 9c8b77fc..99c0d9a6 100644
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -1,7 +1,8 @@
-import type { MessageChannel, WorkerOptions } from 'node:worker_threads'
 import type { EventEmitter } from 'node:events'
-import type { CircularArray } from '../circular-array'
-import type { Task } from '../utility-types'
+import type { MessageChannel, WorkerOptions } from 'node:worker_threads'
+
+import type { CircularArray } from '../circular-array.js'
+import type { Task, TaskFunctionProperties } from '../utility-types.js'
 
 /**
  * Callback invoked when the worker has started successfully.
@@ -40,6 +41,17 @@ export type ExitHandler<Worker extends IWorker> = (
   exitCode: number
 ) => void
 
+/**
+ * Worker event handler.
+ *
+ * @typeParam Worker - Type of worker.
+ */
+export type EventHandler<Worker extends IWorker> =
+  | OnlineHandler<Worker>
+  | MessageHandler<Worker>
+  | ErrorHandler<Worker>
+  | ExitHandler<Worker>
+
 /**
  * Measurement statistics.
  *
@@ -122,10 +134,11 @@ export interface TaskStatistics {
 /**
  * Enumeration of worker types.
  */
-export const WorkerTypes = Object.freeze({
-  thread: 'thread',
-  cluster: 'cluster'
-} as const)
+export const WorkerTypes: Readonly<{ thread: 'thread', cluster: 'cluster' }> =
+  Object.freeze({
+    thread: 'thread',
+    cluster: 'cluster'
+  } as const)
 
 /**
  * Worker type.
@@ -160,9 +173,14 @@ export interface WorkerInfo {
    */
   stealing: boolean
   /**
-   * Task function names.
+   * Back pressure flag.
+   * This flag is set to `true` when worker node tasks queue has back pressure.
+   */
+  backPressure: boolean
+  /**
+   * Task functions properties.
    */
-  taskFunctionNames?: string[]
+  taskFunctionsProperties?: TaskFunctionProperties[]
 }
 
 /**
@@ -201,7 +219,7 @@ export interface StrategyData {
 /**
  * Worker interface.
  */
-export interface IWorker {
+export interface IWorker extends EventEmitter {
   /**
    * Cluster worker id.
    */
@@ -216,28 +234,20 @@ export interface IWorker {
    * @param event - The event.
    * @param handler - The event handler.
    */
-  readonly on: (
-    event: string,
-    handler:
-    | OnlineHandler<this>
-    | MessageHandler<this>
-    | ErrorHandler<this>
-    | ExitHandler<this>
-  ) => void
+  readonly on: (event: string, handler: EventHandler<this>) => this
   /**
    * Registers once an event handler.
    *
    * @param event - The event.
    * @param handler - The event handler.
    */
-  readonly once: (
-    event: string,
-    handler:
-    | OnlineHandler<this>
-    | MessageHandler<this>
-    | ErrorHandler<this>
-    | ExitHandler<this>
-  ) => void
+  readonly once: (event: string, handler: EventHandler<this>) => this
+  /**
+   * Calling `unref()` on a worker allows the thread to exit if this is the only
+   * active handle in the event system. If the worker is already `unref()`ed calling`unref()` again has no effect.
+   * @since v10.5.0
+   */
+  readonly unref?: () => void
   /**
    * Stop all JavaScript execution in the worker thread as soon as possible.
    * Returns a Promise for the exit code that is fulfilled when the `'exit' event` is emitted.
@@ -261,7 +271,8 @@ export interface IWorker {
 export interface WorkerNodeOptions {
   workerOptions?: WorkerOptions
   env?: Record<string, unknown>
-  tasksQueueBackPressureSize: number
+  tasksQueueBackPressureSize: number | undefined
+  tasksQueueBucketSize: number | undefined
 }
 
 /**
@@ -312,25 +323,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.
    */
@@ -341,10 +346,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.
    */
@@ -357,11 +358,7 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown>
    */
   readonly registerWorkerEventHandler: (
     event: string,
-    handler:
-    | OnlineHandler<Worker>
-    | MessageHandler<Worker>
-    | ErrorHandler<Worker>
-    | ExitHandler<Worker>
+    handler: EventHandler<Worker>
   ) => void
   /**
    * Registers once a worker event handler.
@@ -371,11 +368,7 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown>
    */
   readonly registerOnceWorkerEventHandler: (
     event: string,
-    handler:
-    | OnlineHandler<Worker>
-    | MessageHandler<Worker>
-    | ErrorHandler<Worker>
-    | ExitHandler<Worker>
+    handler: EventHandler<Worker>
   ) => void
   /**
    * Gets task function worker usage statistics.
@@ -399,6 +392,6 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown>
  * @internal
  */
 export interface WorkerNodeEventDetail {
-  workerId: number
+  workerId?: number
   workerNodeKey?: number
 }