X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=86f5121dd1d73239c925c51319b6ff8bdc9b2a03;hb=465b29401ecddad49070d3b0df4e55dc3902788c;hp=05b559850c3a16f4d682f25acaf42e20a3f982e0;hpb=027063571693f211b35c8851566a063201adb9af;p=poolifier.git

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index 05b55985..86f5121d 100644
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -1,11 +1,12 @@
 import type { CircularArray } from '../circular-array'
+import type { Queue } from '../queue'
 
 /**
  * Callback invoked if the worker has received a message.
  */
 export type MessageHandler<Worker extends IWorker> = (
   this: Worker,
-  m: unknown
+  message: unknown
 ) => void
 
 /**
@@ -13,7 +14,7 @@ export type MessageHandler<Worker extends IWorker> = (
  */
 export type ErrorHandler<Worker extends IWorker> = (
   this: Worker,
-  e: Error
+  error: Error
 ) => void
 
 /**
@@ -26,58 +27,119 @@ export type OnlineHandler<Worker extends IWorker> = (this: Worker) => void
  */
 export type ExitHandler<Worker extends IWorker> = (
   this: Worker,
-  code: number
+  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 serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
  * @internal
  */
 export interface Task<Data = unknown> {
   /**
-   * Input data that will be passed to the worker.
+   * Task name.
+   */
+  readonly name?: string
+  /**
+   * Task input data that will be passed to the worker.
    */
   readonly data?: Data
   /**
-   * UUID of the message.
+   * Timestamp.
+   */
+  readonly timestamp?: number
+  /**
+   * Message UUID.
    */
   readonly id?: string
 }
 
 /**
- * Worker tasks usage statistics.
+ * Measurement statistics.
+ *
+ * @internal
+ */
+export interface MeasurementStatistics {
+  /**
+   * Measurement aggregate.
+   */
+  aggregate: number
+  /**
+   * Measurement average.
+   */
+  average: number
+  /**
+   * Measurement median.
+   */
+  median: number
+  /**
+   * Measurement history.
+   */
+  history: CircularArray<number>
+}
+
+/**
+ * Event loop utilization measurement statistics.
+ *
+ * @internal
  */
-export interface TasksUsage {
+export interface EventLoopUtilizationMeasurementStatistics {
+  idle: MeasurementStatistics
+  active: MeasurementStatistics
+  utilization: number
+}
+
+/**
+ * Task statistics.
+ *
+ * @internal
+ */
+export interface TaskStatistics {
+  /**
+   * Number of executed tasks.
+   */
+  executed: number
+  /**
+   * Number of executing tasks.
+   */
+  executing: number
   /**
-   * Number of tasks executed.
+   * Number of queued tasks.
    */
-  run: number
+  readonly queued: number
   /**
-   * Number of tasks running.
+   * Maximum number of queued tasks.
    */
-  running: number
+  readonly maxQueued: number
   /**
-   * Tasks runtime.
+   * Number of failed tasks.
    */
-  runTime: number
+  failed: number
+}
+
+/**
+ * Worker usage statistics.
+ *
+ * @internal
+ */
+export interface WorkerUsage {
   /**
-   * Tasks runtime history.
+   * Tasks statistics.
    */
-  runTimeHistory: CircularArray<number>
+  tasks: TaskStatistics
   /**
-   * Average tasks runtime.
+   * Tasks runtime statistics.
    */
-  avgRunTime: number
+  runTime: MeasurementStatistics
   /**
-   * Median tasks runtime.
+   * Tasks wait time statistics.
    */
-  medRunTime: number
+  waitTime: MeasurementStatistics
   /**
-   * Number of tasks errored.
+   * Tasks event loop utilization statistics.
    */
-  error: number
+  elu: EventLoopUtilizationMeasurementStatistics
 }
 
 /**
@@ -88,14 +150,14 @@ export interface IWorker {
    * Register an event listener.
    *
    * @param event - The event.
-   * @param handler - The event listener.
+   * @param handler - The event handler.
    */
   on: ((event: 'message', handler: MessageHandler<this>) => void) &
   ((event: 'error', handler: ErrorHandler<this>) => void) &
   ((event: 'online', handler: OnlineHandler<this>) => void) &
   ((event: 'exit', handler: ExitHandler<this>) => void)
   /**
-   * Register a listener to the exit event that will only performed once.
+   * Register a listener to the exit event that will only be performed once.
    *
    * @param event - `'exit'`.
    * @param handler - The exit handler.
@@ -107,7 +169,7 @@ export interface IWorker {
  * Worker node interface.
  *
  * @typeParam Worker - Type of worker.
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
  * @internal
  */
 export interface WorkerNode<Worker extends IWorker, Data = unknown> {
@@ -116,11 +178,11 @@ export interface WorkerNode<Worker extends IWorker, Data = unknown> {
    */
   readonly worker: Worker
   /**
-   * Worker node tasks usage statistics.
+   * Worker node worker usage statistics.
    */
-  tasksUsage: TasksUsage
+  usage: WorkerUsage
   /**
    * Worker node tasks queue.
    */
-  readonly tasksQueue: Array<Task<Data>>
+  readonly tasksQueue: Queue<Task<Data>>
 }