ClusterWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FClusterWorker.html;h=76fd36b283c5df72fd668322ff2b08ddad4f2ee9;hb=3557031d88b5ff00ea86695728b3ba3af46e9faa;hp=2a3a2826bb865cf40d388aba7a8446967e69566a;hpb=5497d426557f576e3ee314619f83b71685acc6bc;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 2a3a2826..76fd36b2 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -ClusterWorker | poolifier

+ClusterWorker | poolifier - v2.6.12

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

ClusterWorker

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

@@ -73,18 +73,22 @@ but the minimum number of workers will be guaranteed.

Methods

asyncId +

addTaskFunction +asyncId bind -checkAlive emitDestroy getMainWorker handleError +hasTaskFunction messageListener +removeTaskFunction runAsync runInAsyncScope runSync sendToMainWorker +setDefaultTaskFunction triggerAsyncId +workerReady bind

@@ -120,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

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

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

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

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

`Protected` `Readonly` mainWorker

mainWorker: Worker

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

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

`Protected` `Readonly` opts

opts: WorkerOptions = ...

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

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

`Protected` statistics

statistics: WorkerStatistics

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

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

`Protected` taskFunctions

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

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

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

Accessors

@@ -199,9 +203,42 @@ but the minimum number of workers will be guaranteed.

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:196

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

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

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/abstract-worker.ts:153

`Protected` messageListener

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

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

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

`Protected` sendToMainWorker

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