X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FMessageValue.html;h=eee06532659045fe58351c82bb2ece03c56e2562;hb=edf8ce4e11eb0105038fcc236a2049c16b6175d2;hp=09ae76d71435383cb4f20e5fcb04ede5e25e28a6;hpb=f05afd162e34836a52c48b05781750e3421424d8;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 09ae76d7..eee06532 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,4 +1,4 @@ -
Internal
Internal
Message object that is passed between main worker and worker.
Type Parameters
MessageData = unknown
-Type of data sent to and/or from the worker. This can only be serializable data.
-Data = unknown
-Type of data sent to the worker. This can only be serializable data.
+Type of data sent to the worker or execution response. This can only be structured-cloneable data.
MainWorker extends ClusterWorker | MessagePort = ClusterWorker | MessagePort
-Type of main worker.
+ErrorData = unknown
+Type of data sent to the worker triggering an error. This can only be structured-cloneable data.
Hierarchy
-- Task<MessageData>
+
- Task<Data>
- MessageValue
@@ -52,44 +47,48 @@
data?
-id?
+check Active?
+data?
kill?
name?
-parent?
+port?
+ready?
statistics?
task Error?
+task Functions?
+task Id?
task Performance?
timestamp?
+transfer List?
+worker Id
-data?: MessageData
-
+check Active?: boolean
+
-
-id?: string
-- Defined in src/utility-types.ts:134
+
+data?: Data
+
+- Defined in src/utility-types.ts:83
kill?: 1 | "SOFT" | "HARD"
+kill?: true | "success" | "SOFT" | "HARD" | "failure"
+- Defined in src/utility-types.ts:110
name?: string
@@ -98,31 +97,56 @@
-
-parent?: MainWorker
-- Defined in src/utility-types.ts:79
+
+port?: MessagePort
+
+
+
+ready?: boolean
+
+- Defined in src/utility-types.ts:130
statistics?: WorkerStatistics
-
+- Defined in src/utility-types.ts:126
task Error?: TaskError<Data>
+task Error?: TaskError<ErrorData>
+- Defined in src/utility-types.ts:114
+
+task Functions?: string[]
+
+
+
+task Id?: string
+
+
Performance
task Performance?: TaskPerformance
@@ -130,7 +154,7 @@
+- Defined in src/utility-types.ts:118
timestamp?: number
@@ -139,7 +163,25 @@
+- Defined in src/utility-types.ts:91
+
+transfer List?: TransferListItem[]
+
+
+
+worker Id: number
+
+
@@ -159,28 +201,34 @@
+- timestamp
+- transfer
List
+- worker
Id
-
+- Worker
Types
+- available
Parallelism
Properties
-Properties
-
-Optional
Readonly
dataTask input data that will be passed to the worker.
+ Active
+Optional
Readonly
checkWhether the worker starts or stops its activity check.
-Optional
Readonly
idMessage UUID.
+
+Optional
Readonly
dataTask input data that will be passed to the worker.
-Optional
Readonly
killKill code.
Optional
Readonly
name
-Optional
Readonly
parentReference to main worker.
+
+Optional
Readonly
portMessage port.
+
+Optional
Readonly
readyWhether the worker is ready or not.
Optional
Readonly
statisticsWhether to compute the given statistics or not.
+Whether the worker computes the given statistics or not.
Error
-Optional
Readonly
taskTask error.
Functions
+Optional
Readonly
taskTask function names.
+ Id
+Optional
Readonly
taskTask UUID.
+Optional
Readonly
taskOptional
Readonly
timestamp List
+Optional
Readonly
transferArray of transferable objects.
+ Id
+Readonly
workerWorker id.
+On This Page
+- check
Active
- data
-- id
- kill
- name
-- parent
+- port
+- ready
- statistics
- task
Error
+- task
Functions
+- task
Id
- task
Performance
-- timestamp
Generated using TypeDoc
Generated using TypeDoc
\ No newline at end of file