X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;h=7cb8119491d7dc0b5e5c9fc8496720575f762c7b;hb=20ebfb03d96dc805e59643cf1f90667545a3fef2;hp=ccf490a367b5aa9d38c0732fb409033967068255;hpb=842d8918a19fc2720d4436789a2e373bc623452e;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index ccf490a3..7cb81194 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,4 +1,4 @@ -MessageValue | poolifier
+MessageValue | poolifier
+

Interface MessageValue<Data, ErrorData>Internal

-

Message object that is passed between worker and main worker.

-
-
+

Message object that is passed between main worker and worker.

+
+
+

Type Parameters

-
    +
    • -

      Data = unknown

      • +

      Data = unknown

      +

      Type of data sent to the worker or execution response. This can only be structured-cloneable data.

      +
      +
    • -

      MainWorker extends ClusterWorker | MessagePort | unknown = unknown

+

ErrorData = unknown

+

Type of data sent to the worker triggering an error. This can only be structured-cloneable data.

+
+

Hierarchy

    -
  • MessageValue
@@ -38,63 +47,108 @@

Properties

-
data? -error? -id? -kill? -parent? -runTime? +
data? +id? +kill? +name? +started? +statistics? +taskError? +taskPerformance? +timestamp? +workerId?

Properties

-
-

Optional Readonly data

-
data?: Data
-

Input data that will be passed to the worker.

-
-
-

Optional Readonly error

-
error?: string
-

Error.

-
+
+

Optional Readonly kill

+
kill?: 1 | "SOFT" | "HARD"

Kill code.

-
+
+

Optional Readonly name

+
name?: string
+

Task name.

+
+
+
+

Optional Readonly started

+
started?: boolean
+

Whether the worker has started or not.

+
+
+
+

Optional Readonly statistics

+
statistics?: WorkerStatistics
+

Whether the worker computes the given statistics or not.

+
+
+
+

Optional Readonly taskError

+
taskError?: TaskError<ErrorData>
+

Task error.

+
+
+
+

Optional Readonly taskPerformance

+
taskPerformance?: TaskPerformance
+

Task performance.

+
+
-
-

Optional Readonly Internal parent

-
parent?: MainWorker
-

Reference to main worker.

-

Only for internal use.

-
+
+

Optional Readonly timestamp

+
timestamp?: number
+

Timestamp.

+
+
-
-

Optional Readonly runTime

-
runTime?: number
-

Runtime.

-
+
+

Optional Readonly workerId

+
workerId?: number
+

Worker id.

+
+
+
  • Defined in src/utility-types.ts:67
    • -

    Settings

     +

    Settings

    Member Visibility

    @@ -104,58 +158,83 @@
    • -

    Theme

    +

    Theme

    -

    On This Page

     +

    On This Page

    +
  • data
    • +
  • id
    • +
  • kill
    • +
  • name
    • +
  • started
    • +
  • statistics
    • +
  • taskError
    • +
  • taskPerformance
    • +
  • timestamp
    • +
  • workerId
    • -
    +
  • AbstractPool
    • +
  • AbstractWorker
    • +
  • CircularArray
    • +
  • ClusterWorker
    • +
  • DynamicClusterPool
    • +
  • DynamicThreadPool
    • +
  • FixedClusterPool
    • +
  • FixedThreadPool
    • +
  • PoolEmitter
    • +
  • Queue
    • +
  • ThreadWorker
    • +
  • WorkerChoiceStrategyContext
    • +
  • ClusterPoolOptions
    • +
  • EventLoopUtilizationMeasurementStatistics
    • +
  • IPool
    • +
  • IWorker
    • +
  • IWorkerChoiceStrategy
    • +
  • MeasurementOptions
    • +
  • MeasurementStatistics
    • +
  • MeasurementStatisticsRequirements
    • +
  • MessageValue
    • +
  • PoolInfo
    • +
  • PoolOptions
    • +
  • PromiseResponseWrapper
    • +
  • StrategyPolicy
    • +
  • Task
    • +
  • TaskError
    • +
  • TaskPerformance
    • +
  • TaskStatistics
    • +
  • TaskStatisticsRequirements
    • +
  • TasksQueueOptions
    • +
  • ThreadPoolOptions
    • +
  • WorkerChoiceStrategyOptions
    • +
  • WorkerInfo
    • +
  • WorkerNode
    • +
  • WorkerOptions
    • +
  • WorkerStatistics
    • +
  • WorkerUsage
    • +
  • ErrorHandler
    • +
  • ExitHandler
    • +
  • KillBehavior
    • +
  • Measurement
    • +
  • MessageHandler
    • +
  • OnlineHandler
    • +
  • PoolEvent
    • +
  • PoolType
    • +
  • TaskFunctions
    • +
  • WorkerAsyncFunction
    • +
  • WorkerChoiceStrategy
    • +
  • WorkerFunction
    • +
  • WorkerSyncFunction
    • +
  • WorkerType
    • +
  • KillBehaviors
    • +
  • Measurements
    • +
  • PoolEvents
    • +
  • PoolTypes
    • +
  • WorkerChoiceStrategies
    • +
  • WorkerTypes
    • +
  • availableParallelism

    • Generated using TypeDoc

    \ No newline at end of file