ClusterWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FClusterWorker.html;h=a9feb333004fa17d029dc89a17d439e0ee077f48;hb=ccd73e075194fac1cf6e1b736f1556b199c95bc5;hp=6aa60182b1f58d24081995d6f2a4571a4709a246;hpb=8d20e449d72975f6add9177d1097d5a204d14f71;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 6aa60182..a9feb333 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -ClusterWorker | poolifier

+ClusterWorker | poolifier - v2.6.12

@@ -32,12 +32,12 @@ but the minimum number of workers will be guaranteed.

Data = unknown
-
Type of data this worker receives from pool's execution. This can only be serializable data.
+
Type of data this worker receives from pool's execution. This can only be structured-cloneable data.
Response = unknown
-
Type of response the worker sends back to the main worker. This can only be serializable data.
+
Type of response the worker sends back to the main worker. This can only be structured-cloneable data.

@@ -47,7 +47,7 @@ but the minimum number of workers will be guaranteed.

ClusterWorker

Defined in src/worker/cluster-worker.ts:21

@@ -64,22 +64,31 @@ but the minimum number of workers will be guaranteed.

lastTaskTimestamp mainWorker opts +statistics taskFunctions

Accessors

id +

@@ -115,18 +124,18 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/cluster-worker.ts:31

Properties

`Protected` `Optional` `Readonly` aliveInterval

`Protected` `Optional` aliveInterval

aliveInterval?: Timeout

Handler id of the aliveInterval worker alive check.

Defined in src/worker/abstract-worker.ts:62

`Protected` `Readonly` isMain

isMain: boolean

@@ -135,7 +144,7 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/abstract-worker.ts:74

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

@@ -144,16 +153,16 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/abstract-worker.ts:54

`Protected` mainWorker

mainWorker: undefined | null | Worker

`Protected` `Readonly` mainWorker

mainWorker: Worker

Reference to main worker.

Defined in src/worker/abstract-worker.ts:78

`Protected` `Readonly` opts

opts: WorkerOptions = ...

@@ -162,7 +171,16 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/abstract-worker.ts:79

`Protected` statistics

statistics: WorkerStatistics

Performance statistics computation requirements.

`Protected` taskFunctions

taskFunctions: Map<string, WorkerFunction<Data, Response>>

@@ -171,9 +189,56 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/abstract-worker.ts:50

Accessors

`Protected` id

get id(): number
+
Worker id.
+
+
Returns number
+
+
Overrides AbstractWorker.id
+
- Defined in src/worker/cluster-worker.ts:47

Methods

addTaskFunction

addTaskFunction(name, fn): boolean
+
Adds a task function to the worker. +If a task function with the same name already exists, it is replaced.
+
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function to add.
  +
  +
- +
  fn: WorkerFunction<Data, Response>
  +
  The task function to add.
  +
  +
+
Returns boolean
Whether the task function was added or not.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string.
+ +
Throws
https://nodejs.org/api/errors.html#class-error If the name parameter is the default task function reserved name.
+ +
Throws
https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.
+
+
Inherited from AbstractWorker.addTaskFunction
+
- Defined in src/worker/abstract-worker.ts:171

asyncId

Defined in node_modules/.pnpm/@types+node@20.4.1/node_modules/@types/node/async_hooks.d.ts:306

bind

`Protected` checkAlive

checkAlive(): void
-
Checks if the worker should be terminated, because its living too long.
-
-
Returns void
-
-
Inherited from AbstractWorker.checkAlive
-
- Defined in src/worker/abstract-worker.ts:182

Defined in node_modules/.pnpm/@types+node@20.4.1/node_modules/@types/node/async_hooks.d.ts:283

emitDestroy

Defined in node_modules/.pnpm/@types+node@20.4.1/node_modules/@types/node/async_hooks.d.ts:302

`Protected` getMainWorker

Defined in src/worker/abstract-worker.ts:340

`Protected` handleError

handleError(e): string
Handles an error and convert it to a string so it can be sent back to the main worker.
@@ -268,12 +321,35 @@ never be called.

The error raised by the worker.

Returns string

Message of the error.

Returns string

The error message.

hasTaskFunction

hasTaskFunction(name): boolean
+
Checks if the worker has a task function with the given name.
+
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function to check.
  +
  +
+
Returns boolean
Whether the worker has a task function with the given name or not.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string.
+
+
Inherited from AbstractWorker.hasTaskFunction
- Defined in src/worker/cluster-worker.ts:55

Defined in src/worker/abstract-worker.ts:153

`Protected` messageListener

Parameters

-
message: MessageValue<Data, Worker>
+
message: MessageValue<Data, Data>

Message received.

Defined in src/worker/abstract-worker.ts:270

removeTaskFunction

removeTaskFunction(name): boolean
+
Removes a task function from the worker.
+
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function to remove.
  +
  +
+
Returns boolean
Whether the task function existed and was removed or not.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string.
+ +
Throws
https://nodejs.org/api/errors.html#class-error If the name parameter is the default task function reserved name.
+ +
Throws
https://nodejs.org/api/errors.html#class-error If the name parameter is the task function used as default task function.
+
+
Inherited from AbstractWorker.removeTaskFunction
+
- Defined in src/worker/abstract-worker.ts:209

`Protected` runAsync

-
message: MessageValue<Data, Worker | MessagePort>
+
message: MessageValue<Data, unknown>

Input data for the given function.

@@ -318,7 +421,7 @@ never be called.

Defined in src/worker/abstract-worker.ts:410

runInAsyncScope

Defined in node_modules/.pnpm/@types+node@20.4.1/node_modules/@types/node/async_hooks.d.ts:294

`Protected` runSync

-
message: MessageValue<Data, Worker | MessagePort>
+
message: MessageValue<Data, unknown>

Input data for the given function.

@@ -398,7 +501,7 @@ then restore the original execution context.

Defined in src/worker/abstract-worker.ts:372

`Protected` sendToMainWorker

Parameters

-
message: MessageValue<Response, Worker | MessagePort>
+
message: MessageValue<Response, unknown>

The response message.

Defined in src/worker/cluster-worker.ts:52

setDefaultTaskFunction

setDefaultTaskFunction(name): boolean
+
Sets the default task function to use when no task function name is specified.
+
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function to use as default task function.
  +
  +
+
Returns boolean
Whether the default task function was set or not.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string.
+ +
Throws
https://nodejs.org/api/errors.html#class-error If the name parameter is the default task function reserved name.
+ +
Throws
https://nodejs.org/api/errors.html#class-error If the name parameter is a non-existing task function.
+
+
Inherited from AbstractWorker.setDefaultTaskFunction
+
- Defined in src/worker/abstract-worker.ts:237

triggerAsyncId

Defined in node_modules/.pnpm/@types+node@20.4.1/node_modules/@types/node/async_hooks.d.ts:311

`Protected` workerReady

workerReady(): void
+
Notifies the main worker that this worker is ready to process tasks.
+
+
Returns void
+
+
Inherited from AbstractWorker.workerReady
+
- Defined in src/worker/abstract-worker.ts:300

`Static` bind

Defined in node_modules/.pnpm/@types+node@20.4.1/node_modules/@types/node/async_hooks.d.ts:277

WorkerTypes

availableParallelism

Generated using TypeDoc

\ No newline at end of file