X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;h=c5549d7802669376315d212097f10d68b1ac3523;hb=184d530faf6acf70e116cb4a3fb831938b73e2c0;hp=739ae0839c86e0c4aa71ce31eae4081d1d280fae;hpb=7e36fa9f0f844e3e60f0c22de3e28665dd8cc9d1;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 739ae083..c5549d78 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,4 +1,4 @@ -MessageValue | poolifier
+MessageValue | poolifier
+

Interface MessageValue<Data, MainWorker>Internal

Message object that is passed between main worker and worker.

-
+

Type Parameters

-
    +
    • -

      Data = unknown

      +

      Data = unknown

      Type of data sent to the worker. This can only be serializable data.

    • -

      MainWorker extends ClusterWorker | MessagePort | unknown = unknown

      +

      MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort

      Type of main worker.

Hierarchy

+
  • Defined in src/utility-types.ts:20
    • @@ -44,60 +44,93 @@

    Properties

    -
    data? -error? -id? -kill? -parent? -runTime? +
    data? +error? +errorData? +id? +kill? +name? +parent? +runTime? +submissionTimestamp? +waitTime?

    Properties

    -
    +

    Optional Readonly data

    -
    data?: Data
    -

    Input data that will be passed to the worker.

    +
    data?: Data
    +

    Task input data that will be passed to the worker.

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

    Optional Readonly error

    -
    error?: string
    -

    Error.

    +
    error?: string
    +

    Task error.

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

    Optional Readonly errorData

    +
    errorData?: unknown
    +

    Task data triggering task error.

    +
    +

    Optional Readonly id

    -
    id?: string
    -

    UUID of the message.

    +
    id?: string
    +

    Message UUID.

    -
    +
  • Defined in src/pools/worker.ts:55
    • +

    Optional Readonly kill

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

    Kill code.

    -
    -

    Optional Readonly Internal parent

    -
    parent?: MainWorker
    +
  • Defined in src/utility-types.ts:27
    • +
    +

    Optional Readonly name

    +
    name?: string
    +

    Task name.

    +
    +
    +

    Optional Readonly parent

    +
    parent?: MainWorker

    Reference to main worker.

    -

    Only for internal use.

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

    Optional Readonly runTime

    -
    runTime?: number
    +
    runTime?: number

    Runtime.

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

    Optional Readonly submissionTimestamp

    +
    submissionTimestamp?: number
    +

    Submission timestamp.

    +
    +
    +

    Optional Readonly waitTime

    +
    waitTime?: number
    +

    Wait time.

    +
    @@ -112,58 +145,71 @@
    • -

    Theme

    +

    Theme

    On This Page
    +
  • data
    • +
  • error
    • +
  • errorData
    • +
  • id
    • +
  • kill
    • +
  • name
    • +
  • parent
    • +
  • runTime
    • +
  • submissionTimestamp
    • +
  • waitTime
    • +
  • AbstractPool
    • +
  • AbstractWorker
    • +
  • CircularArray
    • +
  • ClusterWorker
    • +
  • DynamicClusterPool
    • +
  • DynamicThreadPool
    • +
  • FixedClusterPool
    • +
  • FixedThreadPool
    • +
  • PoolEmitter
    • +
  • Queue
    • +
  • ThreadWorker
    • +
  • WorkerChoiceStrategyContext
    • +
  • ClusterPoolOptions
    • +
  • IPool
    • +
  • IWorker
    • +
  • IWorkerChoiceStrategy
    • +
  • MessageValue
    • +
  • PoolInfo
    • +
  • PoolOptions
    • +
  • PromiseResponseWrapper
    • +
  • RequiredStatistics
    • +
  • Task
    • +
  • TasksQueueOptions
    • +
  • TasksUsage
    • +
  • WorkerChoiceStrategyOptions
    • +
  • WorkerNode
    • +
  • WorkerOptions
    • +
  • 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