X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;h=e1b26e2219c2290161807d63216c97adb2d3b0b0;hb=3bd6a82e43e11294af91bbd19647944ac740169e;hp=a214542b1a9252d3843fa6331368f907020e0ecf;hpb=d49303bcd1dc86f36030dff08796f869681d4eae;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index a214542b..e1b26e22 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 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. This can only be serializable data.

    +
  • -

    MainWorker extends ClusterWorker | MessagePort | unknown = unknown

+

MainWorker extends ClusterWorker | MessagePort | unknown = unknown

+

Type of main worker.

+

Hierarchy

    -
  • MessageValue
@@ -38,58 +44,59 @@

Properties

-
data? -error? -id? -kill? -parent? -runTime? +
data? +error? +id? +kill? +parent? +runTime?

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:42
    • +

    Optional Readonly error

    -
    error?: string
    +
    error?: string

    Error.

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

    Optional Readonly id

    -
    id?: string
    -

    Id of the message.

    +
    id?: string
    +

    UUID of the message.

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

    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 parent

    +
    parent?: MainWorker

    Reference to main worker.

    -

    Only for internal use.

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

    Optional Readonly runTime

    -
    runTime?: number
    +
    runTime?: number

    Runtime.

    +
  • Defined in src/utility-types.ts:35
    • @@ -104,57 +111,61 @@
    • -

    Theme

    +

    Theme

    On This Page
    +
  • data
    • +
  • error
    • +
  • id
    • +
  • kill
    • +
  • parent
    • +
  • runTime
    • +
  • PoolType
    • +
  • AbstractPool
    • +
  • AbstractWorker
    • +
  • CircularArray
    • +
  • ClusterWorker
    • +
  • DynamicClusterPool
    • +
  • DynamicThreadPool
    • +
  • FixedClusterPool
    • +
  • FixedThreadPool
    • +
  • PoolEmitter
    • +
  • ThreadWorker
    • +
  • WorkerChoiceStrategyContext
    • +
  • ClusterPoolOptions
    • +
  • IPool
    • +
  • IWorker
    • +
  • IWorkerChoiceStrategy
    • +
  • MessageValue
    • +
  • PoolOptions
    • +
  • PromiseResponseWrapper
    • +
  • RequiredStatistics
    • +
  • Task
    • +
  • TasksQueueOptions
    • +
  • TasksUsage
    • +
  • WorkerChoiceStrategyOptions
    • +
  • WorkerNode
    • +
  • WorkerOptions
    • +
  • Draft
    • +
  • ErrorHandler
    • +
  • ExitHandler
    • +
  • KillBehavior
    • +
  • MessageHandler
    • +
  • OnlineHandler
    • +
  • PoolEvent
    • +
  • ThreadWorkerWithMessageChannel
    • +
  • WorkerAsyncFunction
    • +
  • WorkerChoiceStrategy
    • +
  • WorkerFunction
    • +
  • WorkerSyncFunction
    • +
  • KillBehaviors
    • +
  • PoolEvents
    • +
  • WorkerChoiceStrategies

    • Generated using TypeDoc

    \ No newline at end of file