X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;h=36dfd2dbf25a6eb12bfcbc324e5d2fbf236f0568;hb=71056a0ac555e096c1428d6341ef45c7980a6332;hp=2f0e901657f94d5b26d3a2cddcfe34b5bcbec0f2;hpb=88d983fa5c8db26fa52b8a69a2b724ade989db9b;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 2f0e9016..36dfd2db 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -17,18 +17,21 @@

Interface MessageValue<Data, MainWorker>Internal

Message object that is passed between main worker and worker.

-
+ +

Type Parameters

+ +

Hierarchy

+
  • Defined in src/utility-types.ts:30
  • @@ -44,73 +47,126 @@

    Properties

    - +
    data?: Data

    Task input data that will be passed to the worker.

    -
    +
  • Defined in src/pools/worker.ts:48
  • +
    + +
    elu?: EventLoopUtilization
    +

    Event loop utilization.

    +
    +
    - +
    error?: string
    -

    Error.

    -
    +
    + +
    errorData?: unknown
    +

    Task data triggering task error.

    +
    +
    +
  • Defined in src/utility-types.ts:45
  • - +
    id?: string

    Message UUID.

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

    Kill code.

    -
    +
  • Defined in src/utility-types.ts:37
  • - +
    name?: string

    Task name.

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

    Reference to main worker.

    -
    +
  • Defined in src/utility-types.ts:61
  • - +
    runTime?: number

    Runtime.

    -
    +
    + +
    statistics?: WorkerStatistics
    +

    Whether to compute the given statistics or not.

    +
    +
    +
    + +
    timestamp?: number
    +

    Timestamp.

    +
    +
    +
    + +
    waitTime?: number
    +

    Wait time.

    +
    +
    +
  • Defined in src/utility-types.ts:53
  • +
  • data
  • +
  • elu
  • +
  • error
  • +
  • errorData
  • +
  • id
  • +
  • kill
  • +
  • name
  • +
  • parent
  • +
  • runTime
  • +
  • statistics
  • +
  • timestamp
  • +
  • waitTime
  • +
  • AbstractPool
  • +
  • AbstractWorker
  • +
  • CircularArray
  • +
  • ClusterWorker
  • +
  • DynamicClusterPool
  • +
  • DynamicThreadPool
  • +
  • FixedClusterPool
  • +
  • FixedThreadPool
  • +
  • PoolEmitter
  • +
  • Queue
  • +
  • ThreadWorker
  • +
  • WorkerChoiceStrategyContext
  • +
  • ClusterPoolOptions
  • +
  • IPool
  • +
  • IWorker
  • +
  • IWorkerChoiceStrategy
  • +
  • MessageValue
  • +
  • PoolInfo
  • +
  • PoolOptions
  • +
  • PromiseResponseWrapper
  • +
  • Task
  • +
  • TaskPerformance
  • +
  • TaskStatistics
  • +
  • TasksQueueOptions
  • +
  • TasksUsage
  • +
  • ThreadPoolOptions
  • +
  • WorkerChoiceStrategyOptions
  • +
  • WorkerNode
  • +
  • WorkerOptions
  • +
  • WorkerStatistics
  • +
  • Draft
  • +
  • ErrorHandler
  • +
  • ExitHandler
  • +
  • KillBehavior
  • +
  • MessageHandler
  • +
  • OnlineHandler
  • +
  • PoolEvent
  • +
  • PoolType
  • +
  • TaskFunctions
  • +
  • ThreadWorkerWithMessageChannel
  • +
  • WorkerAsyncFunction
  • +
  • WorkerChoiceStrategy
  • +
  • WorkerFunction
  • +
  • WorkerSyncFunction
  • +
  • WorkerType
  • +
  • KillBehaviors
  • +
  • PoolEvents
  • +
  • PoolTypes
  • +
  • WorkerChoiceStrategies
  • +
  • WorkerTypes
  • Generated using TypeDoc

    \ No newline at end of file