X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;h=b42139ab6841b14df4ae6df575cf5a668706a378;hb=36df5bd40369d98d6ccb60400e66dce1aa980d54;hp=d9b845fa1c5f5ed6af55eaf12feb42efe29f28a2;hpb=aac8863d208eadcb0ecb33dc44d045c26f5a444f;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index d9b845fa..b42139ab 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,27 +47,37 @@
data?
+check Active?
+data?
id?
kill?
name?
-parent?
+ready?
statistics?
task Error?
task Performance?
timestamp?
+worker Id
+check Active?: boolean
+
+
-data?: MessageData
+data?: Data
+- Defined in src/utility-types.ts:77
id?: string
@@ -81,15 +86,15 @@
+- Defined in src/utility-types.ts:85
kill?: 1 | "SOFT" | "HARD"
+kill?: true | "SOFT" | "HARD"
+- Defined in src/utility-types.ts:100
name?: string
@@ -98,31 +103,31 @@
-
-parent?: MainWorker
-- Defined in src/utility-types.ts:73
+
+ready?: boolean
+
+- Defined in src/utility-types.ts:116
statistics?: WorkerStatistics
-
+- Defined in src/utility-types.ts:112
task Error?: TaskError<Data>
+task Error?: TaskError<ErrorData>
+- Defined in src/utility-types.ts:104
Performance
task Performance?: TaskPerformance
@@ -130,7 +135,7 @@
+- Defined in src/utility-types.ts:108
timestamp?: number
@@ -139,7 +144,16 @@
+- Defined in src/utility-types.ts:81
+
+worker Id: number
+
+
@@ -159,17 +173,19 @@
+- timestamp
+- worker
Id
-
Properties
-Properties
+ Active
+Optional
Readonly
checkWhether the worker starts or stops its activity check.
+
-Optional
Readonly
data
+Optional
Readonly
dataTask input data that will be passed to the worker.
Optional
Readonly
id
-Optional
Readonly
killKill code.
Optional
Readonly
name
-Optional
Readonly
parentReference to main worker.
+
+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.
Optional
Readonly
taskOptional
Readonly
timestamp Id
+Readonly
workerWorker id.
+On This Page
+- check
Active
- data
- id
- kill
- name
-- parent
+- ready
- statistics
- task
Error
- task
Performance
-- timestamp
Generated using TypeDoc