X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Finterfaces%2FMessageValue.html;h=69e3491a0375082a9c5395f720ca66d2a34d7bbc;hb=f4ff239c096df6dfb39c94eb3f83fd070d3d85d8;hp=ba77a3c678a11c07c438bc7a36b60edaf4454574;hpb=15d6dfaf877ec6a99e2bde48cb3c8a9e8671c075;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index ba77a3c6..69e3491a 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,103 +47,122 @@
data?
-error?
-error Data?
-id?
+check Active?
+data?
kill?
name?
-parent?
-run Time?
-submission Timestamp?
-wait Time?
+port?
+ready?
+statistics?
+task Error?
+task Id?
+task Performance?
+timestamp?
+worker Id
+check Active?: boolean
+
+
-
data?: Data
-
-error?: string
-- Defined in src/utility-types.ts:77
+
+kill?: true | "SOFT" | "HARD"
+
+
+
+name?: string
+
-
-error Data?: unknown
-- Defined in src/utility-types.ts:73
+
+port?: MessagePort
+
-
-id?: string
-- Defined in src/utility-types.ts:124
+
+ready?: boolean
+
-
-kill?: 1 | "SOFT" | "HARD"
-- Defined in src/utility-types.ts:116
+
+statistics?: WorkerStatistics
+
-
-name?: string
-- Defined in src/utility-types.ts:112
+
+task Error?: TaskError<ErrorData>
+
-
-parent?: MainWorker
-- Defined in src/utility-types.ts:104
+
+task Id?: string
+
-
-run Time?: number
-- Defined in src/utility-types.ts:85
+
+task Performance?: TaskPerformance
+
-
-submission Timestamp?: number
-- Defined in src/utility-types.ts:108
+
+timestamp?: number
+
-
-wait Time?: number
-- Defined in src/utility-types.ts:81
+
+worker Id: number
+
+- Defined in src/utility-types.ts:69
@@ -163,18 +182,20 @@
+- port
+- ready
+- statistics
+- task
Error
+- task
Id
+- task
Performance
+- timestamp
+- 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
errorTask error.
+
+Optional
Readonly
killKill code.
+
+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.
+ Id
+Optional
Readonly
taskTask UUID.
Time
-Optional
Readonly
runRuntime.
+ Performance
+Optional
Readonly
taskTask performance.
Timestamp
-Optional
Readonly
submissionSubmission timestamp.
+
+Optional
Readonly
timestampTimestamp.
Time
-Optional
Readonly
waitWait time.
+ Id
+Readonly
workerWorker id.
On This Page
+- check
Active
- data
-- error
-- error
Data
-- id
- kill
- name
-- parent
-- run
Time
-- submission
Timestamp
-- wait
Time
Generated using TypeDoc