X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FMessageValue.html;h=eee06532659045fe58351c82bb2ece03c56e2562;hb=edf8ce4e11eb0105038fcc236a2049c16b6175d2;hp=3f612975f354af3f49bd21e762b7227701660228;hpb=fddf9cc424b3ace38fd414899c666c76a03c3aff;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 3f612975..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.
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.
@@ -47,104 +47,114 @@
data?
-elu?
-error?
-error Data?
-id?
+check Active?
+data?
kill?
name?
-parent?
-run Time?
+port?
+ready?
statistics?
+task Error?
+task Functions?
+task Id?
+task Performance?
timestamp?
-wait Time?
+transfer List?
+worker Id
+check Active?: boolean
+
+
-
data?: Data
-
-elu?: EventLoopUtilization
-- Defined in src/utility-types.ts:83
+
+kill?: true | "success" | "SOFT" | "HARD" | "failure"
+
-
-error?: string
-- Defined in src/utility-types.ts:110
+
+name?: string
+
-
-error Data?: unknown
-- Defined in src/utility-types.ts:79
+
+port?: MessagePort
+
-
-id?: string
-- Defined in src/utility-types.ts:138
+
+ready?: boolean
+
-
-kill?: 1 | "SOFT" | "HARD"
-- Defined in src/utility-types.ts:130
+
+statistics?: WorkerStatistics
+
-
-name?: string
-- Defined in src/utility-types.ts:126
+
+task Error?: TaskError<ErrorData>
+
-
-parent?: MainWorker
-- Defined in src/utility-types.ts:114
+
+task Functions?: string[]
+
-
-run Time?: number
-- Defined in src/utility-types.ts:122
+
+task Id?: string
+
-
-statistics?: WorkerStatistics
-- Defined in src/utility-types.ts:95
+
+task Performance?: TaskPerformance
+
+- Defined in src/utility-types.ts:118
timestamp?: number
@@ -153,15 +163,25 @@
-
-wait Time?: number
-- Defined in src/utility-types.ts:91
+
+transfer List?: TransferListItem[]
+
+
+
+worker Id: number
+
+- Defined in src/utility-types.ts:75
@@ -181,68 +201,86 @@
+- transfer
List
+- worker
Id
-
+- Worker
Types
+- available
Parallelism
-
+
\ No newline at end of file
Properties
-Properties
+ Active
+Optional
Readonly
checkWhether the worker starts or stops its activity check.
+
+Optional
Readonly
dataOptional
Readonly
dataTask input data that will be passed to the worker.
-Optional
Readonly
eluEvent loop utilization.
+
+Optional
Readonly
killKill code.
-Optional
Readonly
errorTask error.
+
+Optional
Readonly
nameTask name.
Data
-Optional
Readonly
errorTask data triggering task error.
+
+Optional
Readonly
portMessage port.
-Optional
Readonly
idMessage UUID.
+
+Optional
Readonly
readyWhether the worker is ready or not.
-Optional
Readonly
killKill code.
+
+Optional
Readonly
statisticsWhether the worker computes the given statistics or not.
-Optional
Readonly
nameTask name.
+ Error
+Optional
Readonly
taskTask error.
-Optional
Readonly
parentReference to main worker.
+ Functions
+Optional
Readonly
taskTask function names.
Time
-Optional
Readonly
runRuntime.
+ Id
+Optional
Readonly
taskTask UUID.
-Optional
Readonly
statisticsWhether to compute the given statistics or not.
+ Performance
+Optional
Readonly
taskTask performance.
Optional
Readonly
timestamp Time
-Optional
Readonly
waitWait time.
+ List
+Optional
Readonly
transferArray of transferable objects.
+ Id
+Readonly
workerWorker id.
On This Page
+- check
Active
- data
-- elu
-- error
-- error
Data
-- id
- kill
- name
-- parent
-- run
Time
+- port
+- ready
- statistics
+- task
Error
+- task
Functions
+- task
Id
+- task
Performance
- timestamp
-- wait
Time
Generated using TypeDoc
Generated using TypeDoc