X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;h=1cc063bec19077809a1a2550026792d4b72edf5f;hb=dc32abbbbd36504ce933a0403cc245899c25a828;hp=87aa7d2bf9ed6988d095e5a1f4e3f5a8043f6924;hpb=749e1fa387ba832c85f789337b3c2e679331cb64;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 87aa7d2b..1cc063be 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -14,29 +14,37 @@ -

Interface MessageValue<Data, MainWorker>Internal

+

Interface MessageValue<MessageData, Data, MainWorker>Internal

Message object that is passed between main worker and worker.

-
+ +

Type Parameters

+ +

Hierarchy

+
  • Defined in src/utility-types.ts:64
  • @@ -44,64 +52,99 @@

    Properties

    - -
    data?: Data
    + +
    data?: MessageData

    Task input data that will be passed to the worker.

    -
    -
    - -
    error?: string
    -

    Error.

    -
    +
  • Defined in src/pools/worker.ts:47
  • - +
    id?: string
    -

    UUID of the message.

    -
    +
  • Defined in src/pools/worker.ts:55
  • - +
    kill?: 1 | "SOFT" | "HARD"

    Kill code.

    -
    +
    + +
    name?: string
    +

    Task name.

    +
    +
    +
  • Defined in src/pools/worker.ts:43
  • - +
    parent?: MainWorker

    Reference to main worker.

    -
    +
    + +
    statistics?: WorkerStatistics
    +

    Whether to compute the given statistics or not.

    +
    +
    +
    + +
    taskError?: TaskError<Data>
    +

    Task error.

    +
    +
    +
    + +
    taskPerformance?: TaskPerformance
    +

    Task performance.

    +
    +
    -
    - -
    runTime?: number
    -

    Runtime.

    -
    +
    + +
    timestamp?: number
    +

    Timestamp.

    +
    +
    +
  • Defined in src/pools/worker.ts:51
  • +
  • data
  • +
  • id
  • +
  • kill
  • +
  • name
  • +
  • parent
  • +
  • statistics
  • +
  • taskError
  • +
  • taskPerformance
  • +
  • timestamp
  • +
  • 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
  • +
  • WorkerNode
  • +
  • WorkerOptions
  • +
  • WorkerStatistics
  • +
  • WorkerUsage
  • +
  • Draft
  • +
  • ErrorHandler
  • +
  • ExitHandler
  • +
  • KillBehavior
  • +
  • Measurement
  • +
  • MessageHandler
  • +
  • OnlineHandler
  • +
  • PoolEvent
  • +
  • PoolType
  • +
  • TaskFunctions
  • +
  • ThreadWorkerWithMessageChannel
  • +
  • WorkerAsyncFunction
  • +
  • WorkerChoiceStrategy
  • +
  • WorkerFunction
  • +
  • WorkerSyncFunction
  • +
  • WorkerType
  • +
  • KillBehaviors
  • +
  • Measurements
  • +
  • PoolEvents
  • +
  • PoolTypes
  • +
  • WorkerChoiceStrategies
  • +
  • WorkerTypes
  • Generated using TypeDoc

    \ No newline at end of file