X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;h=36a3f7582c4f2628505891109ec2575f9ab28a96;hb=0e16e60a89029abe61cda7ba293c036298cced05;hp=11fc7b52db0d6a66017db61312360dd87a9f1d1d;hpb=f8350486e75b15ed17249cda3d0a55ee807a6a9f;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 11fc7b52..36a3f758 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,4 +1,4 @@ -MessageValue | poolifier
+MessageValue | poolifier - v2.6.26
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.26
    @@ -14,21 +14,24 @@ -

    Interface MessageValue<Data, MainWorker>Internal

    +

    Interface MessageValue<Data, ErrorData>Internal

    Message object that is passed between main worker and worker.

    -
    + +

    Type Parameters

    +

    ErrorData = unknown

    +

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

    +
    +

    Hierarchy

    +
  • Defined in src/utility-types.ts:99
    • @@ -44,98 +47,146 @@

    Properties

    -
    data? -error? -errorData? -id? -kill? -name? -parent? -runTime? -submissionTimestamp? -waitTime? +
    checkActive? +data? +kill? +name? +port? +ready? +statistics? +taskError? +taskFunctions? +taskId? +taskPerformance? +timestamp? +transferList? +workerId

    Properties

    +
    +

    Optional Readonly checkActive

    +
    checkActive?: boolean
    +

    Whether the worker starts or stops its activity check.

    +
    +
    -

    Optional Readonly data

    +

    Optional Readonly data

    data?: Data

    Task input data that will be passed to the worker.

    -
    -
    -

    Optional Readonly error

    -
    error?: string
    -

    Task error.

    -
    -
    -

    Optional Readonly errorData

    -
    errorData?: unknown
    -

    Task data triggering task error.

    -
    -
    -

    Optional Readonly id

    -
    id?: string
    -

    Message UUID.

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

    Optional Readonly kill

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

    Optional Readonly kill

    +
    kill?: true | "success" | "SOFT" | "HARD" | "failure"

    Kill code.

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

    Optional Readonly name

    +

    Optional Readonly name

    name?: string

    Task name.

    -
    -
    -

    Optional Readonly parent

    -
    parent?: MainWorker
    -

    Reference to main worker.

    -
    -
    -

    Optional Readonly runTime

    -
    runTime?: number
    -

    Runtime.

    -
    -
    -

    Optional Readonly submissionTimestamp

    -
    submissionTimestamp?: number
    -

    Submission timestamp.

    -
    -
    -

    Optional Readonly waitTime

    -
    waitTime?: number
    -

    Wait time.

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

    Optional Readonly port

    +
    port?: MessagePort
    +

    Message port.

    +
    +
    +
    +

    Optional Readonly ready

    +
    ready?: boolean
    +

    Whether the worker is ready 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 taskFunctions

    +
    taskFunctions?: string[]
    +

    Task function names.

    +
    +
    +
    +

    Optional Readonly taskId

    +
    taskId?: string
    +

    Task UUID.

    +
    +
    +
    +

    Optional Readonly taskPerformance

    +
    taskPerformance?: TaskPerformance
    +

    Task performance.

    +
    +
    +
    +

    Optional Readonly timestamp

    +
    timestamp?: number
    +

    Timestamp.

    +
    +
    +
    +

    Optional Readonly transferList

    +
    transferList?: TransferListItem[]
    +

    Array of transferable objects.

    +
    +
    +
    +

    Readonly workerId

    +
    workerId: number
    +

    Worker id.

    +
    +
    -

    Settings

     +

    Settings

    Member Visibility

    @@ -147,65 +198,86 @@

    Theme

    -

    On This Page

     +

    On This Page

    +
  • checkActive
    • +
  • data
    • +
  • kill
    • +
  • name
    • +
  • port
    • +
  • ready
    • +
  • statistics
    • +
  • taskError
    • +
  • taskFunctions
    • +
  • taskId
    • +
  • taskPerformance
    • +
  • timestamp
    • +
  • transferList
    • +
  • workerId
    • -
    +
  • AbstractPool
    • +
  • AbstractWorker
    • +
  • CircularArray
    • +
  • ClusterWorker
    • +
  • DynamicClusterPool
    • +
  • DynamicThreadPool
    • +
  • FixedClusterPool
    • +
  • FixedThreadPool
    • +
  • PoolEmitter
    • +
  • Queue
    • +
  • ThreadWorker
    • +
  • WorkerChoiceStrategyContext
    • +
  • ClusterPoolOptions
    • +
  • EventLoopUtilizationMeasurementStatistics
    • +
  • IPool
    • +
  • IWorker
    • +
  • IWorkerChoiceStrategy
    • +
  • IWorkerNode
    • +
  • MeasurementOptions
    • +
  • MeasurementStatistics
    • +
  • MeasurementStatisticsRequirements
    • +
  • MessageValue
    • +
  • PoolInfo
    • +
  • PoolOptions
    • +
  • PromiseResponseWrapper
    • +
  • StrategyPolicy
    • +
  • Task
    • +
  • TaskError
    • +
  • TaskPerformance
    • +
  • TaskStatistics
    • +
  • TaskStatisticsRequirements
    • +
  • TasksQueueOptions
    • +
  • ThreadPoolOptions
    • +
  • WorkerChoiceStrategyOptions
    • +
  • WorkerInfo
    • +
  • WorkerOptions
    • +
  • WorkerStatistics
    • +
  • WorkerUsage
    • +
  • ErrorHandler
    • +
  • ExitHandler
    • +
  • KillBehavior
    • +
  • KillHandler
    • +
  • Measurement
    • +
  • MessageHandler
    • +
  • OnlineHandler
    • +
  • PoolEvent
    • +
  • PoolType
    • +
  • TaskAsyncFunction
    • +
  • TaskFunction
    • +
  • TaskFunctions
    • +
  • TaskSyncFunction
    • +
  • WorkerChoiceStrategy
    • +
  • WorkerType
    • +
  • KillBehaviors
    • +
  • Measurements
    • +
  • PoolEvents
    • +
  • PoolTypes
    • +
  • WorkerChoiceStrategies
    • +
  • WorkerTypes
    • +
  • availableParallelism

    • Generated using TypeDoc

    \ No newline at end of file