ClusterWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FClusterWorker.html;h=19af66cab32cb8d6049a0456988d5ee8fd69bf2d;hb=44b95861ed9dfa91b25f397c9b3cad9586454546;hp=76fd36b283c5df72fd668322ff2b08ddad4f2ee9;hpb=3557031d88b5ff00ea86695728b3ba3af46e9faa;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 76fd36b2..19af66ca 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -ClusterWorker | poolifier - v2.6.12

+ClusterWorker | poolifier - v2.6.15

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

ClusterWorker

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

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

Properties

aliveInterval? +

activeInterval? isMain lastTaskTimestamp mainWorker @@ -82,13 +82,14 @@ but the minimum number of workers will be guaranteed.

hasTaskFunction messageListener removeTaskFunction +run runAsync runInAsyncScope runSync +sendReadyResponse sendToMainWorker setDefaultTaskFunction triggerAsyncId -workerReady bind

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

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

Properties

`Protected` `Optional` aliveInterval

aliveInterval?: Timeout

Handler id of the aliveInterval worker alive check.

`Protected` `Optional` activeInterval

activeInterval?: Timeout

Handler id of the activeInterval worker activity check.

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

`Protected` `Readonly` isMain

isMain: boolean

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

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

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

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

`Protected` `Readonly` mainWorker

mainWorker: Worker

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

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

`Protected` `Readonly` opts

opts: WorkerOptions = ...

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

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

`Protected` statistics

statistics: WorkerStatistics

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

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

`Protected` taskFunctions

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

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

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

Accessors

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

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

Methods

@@ -238,7 +239,7 @@ If a task function with the same name already exists, it is replaced.

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

`Protected` messageListener

message: MessageValue<Data, Data>
-
Message received.
+
The received message.

Returns void

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

removeTaskFunction

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

`Protected` run

run(task): void
+
Runs the given task.
+
+
+
Parameters
+
- +
  task: Task<Data>
  +
  The task to execute.
  +
  +
+
Returns void
+
+
Throws
https://nodejs.org/api/errors.html#class-error If the task function is not found.
+
+
Inherited from AbstractWorker.run
+
- Defined in src/worker/abstract-worker.ts:379

`Protected` runAsync

runAsync(fn, message): void
runAsync(fn, task): void
-
Runs the given function asynchronously.
+
Runs the given task function asynchronously.
Parameters
- fn: WorkerAsyncFunction<Data, Response>
  -
  Function that will be executed.
  +
  Task function that will be executed.
- -
  message: MessageValue<Data, unknown>
  -
  Input data for the given function.
  +
  task: Task<Data>
  +
  Input data for the task function.
Returns void
Inherited from AbstractWorker.runAsync
- Defined in src/worker/abstract-worker.ts:410

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

runInAsyncScope

`Protected` runSync

runSync(fn, message): void
runSync(fn, task): void
-
Runs the given function synchronously.
+
Runs the given task function synchronously.
Parameters
- fn: WorkerSyncFunction<Data, Response>
  -
  Function that will be executed.
  +
  Task function that will be executed.
- -
  message: MessageValue<Data, unknown>
  -
  Input data for the given function.
  +
  task: Task<Data>
  +
  Input data for the task function.
Returns void
Inherited from AbstractWorker.runSync
- Defined in src/worker/abstract-worker.ts:372

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

`Protected` sendReadyResponse

sendReadyResponse(): void
+
Sends the ready response to the main worker.
+
+
Returns void
+
+
Inherited from AbstractWorker.sendReadyResponse
+
- Defined in src/worker/abstract-worker.ts:308

`Protected` sendToMainWorker

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

setDefaultTaskFunction

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

triggerAsyncId

Inherited from AbstractWorker.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

constructor
aliveInterval
activeInterval
isMain
lastTaskTimestamp
mainWorker

hasTaskFunction
messageListener
removeTaskFunction
run
runAsync
runInAsyncScope
runSync
sendReadyResponse
sendToMainWorker
setDefaultTaskFunction
triggerAsyncId
workerReady
bind

task: Task<Data>

fn: WorkerSyncFunction<Data, Response>

message: MessageValue<Data, unknown>

task: Task<Data>