X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;h=eee06532659045fe58351c82bb2ece03c56e2562;hb=edf8ce4e11eb0105038fcc236a2049c16b6175d2;hp=7eea515565d6cc48dfe6d446c2b0b7a4ab79c89f;hpb=6be0ab6d5c78c8e91cc4668d3d03db95f15cbfab;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 7eea5155..eee06532 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,4 +1,4 @@ -MessageValue | poolifier
+MessageValue | poolifier - v2.6.38
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.38
    @@ -14,7 +14,7 @@ -

    Interface MessageValue<MessageData, Data, MainWorker>Internal

    +

    Interface MessageValue<Data, ErrorData>Internal

    Message object that is passed between main worker and worker.

    @@ -23,28 +23,23 @@

    Type Parameters

    Hierarchy

    +
  • Defined in src/utility-types.ts:105
    • @@ -52,44 +47,48 @@

    Properties

    -
    data? -id? +
    checkActive? +data? kill? name? -parent? +port? +ready? statistics? taskError? +taskFunctions? +taskId? taskPerformance? timestamp? +transferList? +workerId

    Properties

    -
    -

    Optional Readonly data

    -
    data?: MessageData
    -

    Task input data that will be passed to the worker.

    +
    +

    Optional Readonly checkActive

    +
    checkActive?: boolean
    +

    Whether the worker starts or stops its activity check.

    -
    -

    Optional Readonly id

    -
    id?: string
    -

    Message UUID.

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

    Optional Readonly data

    +
    data?: Data
    +

    Task input data that will be passed to the worker.

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

    • Optional Readonly kill

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

    Kill code.

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

    • Optional Readonly name

    name?: string
    @@ -98,31 +97,56 @@
    -
    -

    Optional Readonly parent

    -
    parent?: MainWorker
    -

    Reference to main worker.

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

    Optional Readonly port

    +
    port?: MessagePort
    +

    Message port.

    +
    +
    +
    +

    Optional Readonly ready

    +
    ready?: boolean
    +

    Whether the worker is ready or not.

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

    • Optional Readonly statistics

    statistics?: WorkerStatistics
    -

    Whether to compute the given statistics or not.

    +

    Whether the worker computes the given statistics or not.

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

    • Optional Readonly taskError

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

    Task error.

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

    Optional Readonly taskFunctions

    +
    taskFunctions?: string[]
    +

    Task function names.

    +
    +
    +
    +

    Optional Readonly taskId

    +
    taskId?: string
    +

    Task UUID.

    +
    +

    Optional Readonly taskPerformance

    taskPerformance?: TaskPerformance
    @@ -130,7 +154,7 @@
    +
  • Defined in src/utility-types.ts:118

    • Optional Readonly timestamp

    timestamp?: number
    @@ -139,7 +163,25 @@
    +
  • Defined in src/utility-types.ts:91
    • +
    +

    Optional Readonly transferList

    +
    transferList?: TransferListItem[]
    +

    Array of transferable objects.

    +
    +
    +
    +

    Readonly workerId

    +
    workerId: number
    +

    Worker id.

    +
    +
    @@ -159,28 +201,34 @@

    On This Page

    +
  • timestamp
    • +
  • transferList
    • +
  • workerId
    • -
    +
  • WorkerTypes
    • +
  • availableParallelism
    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file