perf: optimize task(s) stealing
[poolifier.git] / src / utility-types.ts
index e407309a3d0e221a929a89a5d25cc84466a1e51e..82f79230accb88160ae612e9d5cc5ba7da57d157 100644 (file)
@@ -1,6 +1,8 @@
+import type { AsyncResource } from 'node:async_hooks'
 import type { EventLoopUtilization } from 'node:perf_hooks'
 import type { MessagePort, TransferListItem } from 'node:worker_threads'
-import type { AsyncResource } from 'node:async_hooks'
+
+import type { WorkerChoiceStrategy } from './pools/selection-strategies/selection-strategies-types.js'
 import type { KillBehavior } from './worker/worker-options.js'
 
 /**
@@ -63,6 +65,24 @@ export interface WorkerStatistics {
   readonly elu: boolean
 }
 
+/**
+ * Task function properties.
+ */
+export interface TaskFunctionProperties {
+  /**
+   * Task function name.
+   */
+  readonly name: string
+  /**
+   * Task function priority. Lower values have higher priority.
+   */
+  readonly priority?: number
+  /**
+   * Task function worker choice strategy.
+   */
+  readonly strategy?: WorkerChoiceStrategy
+}
+
 /**
  * Message object that is passed as a task between main worker and worker.
  *
@@ -78,10 +98,20 @@ export interface Task<Data = unknown> {
    * Task input data that will be passed to the worker.
    */
   readonly data?: Data
+  /**
+   * Task priority. Lower values have higher priority.
+   *
+   * @defaultValue 0
+   */
+  readonly priority?: number
+  /**
+   * Task worker choice strategy.
+   */
+  readonly strategy?: WorkerChoiceStrategy
   /**
    * Array of transferable objects.
    */
-  readonly transferList?: TransferListItem[]
+  readonly transferList?: readonly TransferListItem[]
   /**
    * Timestamp.
    */
@@ -89,7 +119,7 @@ export interface Task<Data = unknown> {
   /**
    * Task UUID.
    */
-  readonly taskId?: string
+  readonly taskId?: `${string}-${string}-${string}-${string}-${string}`
 }
 
 /**
@@ -129,17 +159,17 @@ export interface MessageValue<Data = unknown, ErrorData = unknown>
    */
   readonly taskFunctionOperationStatus?: boolean
   /**
-   * Task function serialized to string.
+   * Task function properties.
    */
-  readonly taskFunction?: string
+  readonly taskFunctionProperties?: TaskFunctionProperties
   /**
-   * Task function name.
+   * Task function serialized to string.
    */
-  readonly taskFunctionName?: string
+  readonly taskFunction?: string
   /**
-   * Task function names.
+   * Task functions properties.
    */
-  readonly taskFunctionNames?: string[]
+  readonly taskFunctionsProperties?: TaskFunctionProperties[]
   /**
    * Whether the worker computes the given statistics or not.
    */