X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;h=f0d3690a0030287ac4958dc393ed7438ec4ef19d;hb=c97a785f1274883c88a77d2bf418ba6480d20d04;hp=e56240d2b3fd08208730519bd1074b32d75e65d3;hpb=004a8816ae9b52388de246a9c7a5184a73915ad6;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index e56240d2..f0d3690a 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,71 +47,46 @@
data?
-elu?
-error?
-error Data?
-id?
+check Active?
+data?
kill?
name?
-parent?
-run Time?
+port?
+ready?
statistics?
+task Error?
+task Id?
+task Performance?
timestamp?
-wait Time?
+worker Id
+check Active?: boolean
+
+
-
data?: Data
-
-elu?: EventLoopUtilization
-
-
-
-error?: string
-
-
-
-error Data?: unknown
-
-
-
-id?: string
-
-
+- Defined in src/utility-types.ts:77
kill?: 1 | "SOFT" | "HARD"
+kill?: true | "SOFT" | "HARD"
+- Defined in src/utility-types.ts:100
name?: string
@@ -120,31 +95,56 @@
-
-parent?: MainWorker
-- Defined in src/utility-types.ts:73
+
+port?: MessagePort
+
-
-run Time?: number
-- Defined in src/utility-types.ts:124
+
+ready?: boolean
+
+- Defined in src/utility-types.ts:116
statistics?: WorkerStatistics
-statistics?: WorkerStatistics
+
+
+
+task Error?: TaskError<ErrorData>
+
+
+
+task Id?: string
+
+
+
+task Performance?: TaskPerformance
+
+- Defined in src/utility-types.ts:108
timestamp?: number
@@ -153,15 +153,16 @@
-
-wait Time?: number
-- Defined in src/utility-types.ts:81
+
+worker Id: number
+
+- Defined in src/utility-types.ts:69
@@ -181,20 +182,20 @@
+- worker
Id
-
+- Worker
Types
+- available
Parallelism
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
errorTask error.
- Data
-Optional
Readonly
errorTask data triggering task error.
-
-Optional
Readonly
idMessage UUID.
-
-Optional
Readonly
killKill code.
Optional
Readonly
name
-Optional
Readonly
parentReference to main worker.
+
+Optional
Readonly
portMessage port.
Time
-Optional
Readonly
runRuntime.
+
+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.
+ Id
+Optional
Readonly
taskTask UUID.
+ Performance
+Optional
Readonly
taskTask performance.
Optional
Readonly
timestamp Time
-Optional
Readonly
waitWait time.
+ 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
Id
+- task
Performance
- timestamp
-- wait
Time
Generated using TypeDoc