X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Finterfaces%2FMessageValue.html;h=0743af71890d68160f693b4ff01e8607e28cbad4;hb=f38f85c043864b68ea519f6bdf94821c356195f1;hp=e56240d2b3fd08208730519bd1074b32d75e65d3;hpb=f45a3823ad04902b4c446c7c7de55ca183041953;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index e56240d2..0743af71 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,54 +47,37 @@
data?
-elu?
-error?
-error Data?
+check Alive?
+data?
id?
kill?
name?
-parent?
-run Time?
+ready?
statistics?
+task Error?
+task Performance?
timestamp?
-wait Time?
+worker Id
+check Alive?: boolean
+
+
-
data?: Data
-
-elu?: EventLoopUtilization
-
-
-
-error?: string
-
-
-
-error Data?: unknown
-
-
+- Defined in src/pools/worker.ts:50
id?: string
@@ -103,15 +86,15 @@
+- Defined in src/pools/worker.ts:58
kill?: 1 | "SOFT" | "HARD"
+kill?: true | "SOFT" | "HARD"
+- Defined in src/utility-types.ts:63
name?: string
@@ -120,31 +103,39 @@
-
-parent?: MainWorker
-- Defined in src/pools/worker.ts:46
+
+ready?: boolean
+
-
-run Time?: number
-- Defined in src/utility-types.ts:79
+
+statistics?: WorkerStatistics
+
-
-statistics?: WorkerStatistics
-- Defined in src/utility-types.ts:75
+
+task Error?: TaskError<ErrorData>
+
+
+
+task Performance?: TaskPerformance
+
+- Defined in src/utility-types.ts:71
timestamp?: number
@@ -153,15 +144,16 @@
-
-wait Time?: number
-- Defined in src/pools/worker.ts:54
+
+worker Id: number
+
+- Defined in src/pools/worker.ts:42
@@ -181,20 +173,19 @@
+- worker
Id
-
+- Worker
Types
+- available
Parallelism
Properties
-Properties
+ Alive
+Optional
Readonly
checkWhether the worker starts or stops its aliveness 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
id
-Optional
Readonly
killKill code.
Optional
Readonly
name
-Optional
Readonly
parentReference to main worker.
+
+Optional
Readonly
readyWhether the worker is ready or not.
Time
-Optional
Readonly
runRuntime.
+
+Optional
Readonly
statisticsWhether the worker computes the given statistics or not.
-Optional
Readonly
statisticsWhether to compute the given statistics or not.
+ Error
+Optional
Readonly
taskTask error.
+ Performance
+Optional
Readonly
taskTask performance.
Optional
Readonly
timestamp Time
-Optional
Readonly
waitWait time.
+ Id
+Readonly
workerWorker id.
On This Page
+- check
Alive
- data
-- elu
-- error
-- error
Data
- id
- kill
- name
-- parent
-- run
Time
+- ready
- statistics
+- task
Error
+- task
Performance
- timestamp
-- wait
Time
Generated using TypeDoc