ClusterWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FClusterWorker.html;h=b890f4d44cc135f84300430e7685bd8f1d3518f3;hb=2447ee8ce5d3db1253c7286482e5a54e84618ecf;hp=76fd36b283c5df72fd668322ff2b08ddad4f2ee9;hpb=68887e30ceca3df78b70e0b8f1b262a76f2d7cd8;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 76fd36b2..b890f4d4 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -ClusterWorker | poolifier - v2.6.12

+ClusterWorker | poolifier - v2.6.24

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

ClusterWorker

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

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

Properties

aliveInterval? +

activeInterval? isMain lastTaskTimestamp -mainWorker opts statistics taskFunctions @@ -79,16 +78,19 @@ but the minimum number of workers will be guaranteed.

emitDestroy getMainWorker handleError +handleKillMessage +handleReadyMessage hasTaskFunction +listTaskFunctions messageListener removeTaskFunction +run runAsync runInAsyncScope runSync sendToMainWorker setDefaultTaskFunction triggerAsyncId -workerReady bind

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

Parameters

-
taskFunctions: WorkerFunction<Data, Response> | TaskFunctions<Data, Response>
+
taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>

Task function(s) processed by the worker when the pool's execution function is invoked.

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 +146,7 @@ but the minimum number of workers will be guaranteed.

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

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

`Protected` `Readonly` mainWorker

mainWorker: Worker

Reference to main worker.

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

`Protected` `Readonly` opts

opts: WorkerOptions = ...

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

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

`Protected` statistics

statistics: WorkerStatistics

@@ -180,16 +173,16 @@ 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>>

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

Task function(s) processed by the worker when the pool's execution function is invoked.

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

Accessors

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

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

Methods

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

fn: WorkerFunction<Data, Response>

fn: TaskFunction<Data, Response>

The task function to add.

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

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

asyncId

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

bind

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

emitDestroy

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

`Protected` getMainWorker

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

`Protected` handleError

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

`Protected` handleKillMessage

handleKillMessage(message): void
+
Handles a kill message sent by the main worker.
+
+
+
Parameters
+
- +
  message: MessageValue<Data, unknown>
  +
  The kill message.
  +
  +
+
Returns void
+
+
Inherited from AbstractWorker.handleKillMessage
+
- Defined in src/worker/abstract-worker.ts:322

`Protected` handleReadyMessage

handleReadyMessage(message): void
+
Handles the ready message sent by the main worker.
+
+
+
Parameters
+
- +
  message: MessageValue<Data, unknown>
  +
  The ready message.
  +
  +
+
Returns void
+
+
Overrides AbstractWorker.handleReadyMessage
+
- Defined in src/worker/cluster-worker.ts:45

hasTaskFunction

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

listTaskFunctions

listTaskFunctions(): string[]
+
Lists the names of the worker's task functions.
+
+
Returns string[]
The names of the worker's task functions.
+ +
+
Inherited from AbstractWorker.listTaskFunctions
+
- Defined in src/worker/abstract-worker.ts:245

`Protected` messageListener

Parameters

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

Returns void

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

removeTaskFunction

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

`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:397

`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.
  +
  fn: TaskAsyncFunction<Data, Response>
  +
  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:451

runInAsyncScope

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

`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.
  +
  fn: TaskSyncFunction<Data, Response>
  +
  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:415

`Protected` sendToMainWorker

sendToMainWorker(message): void
-
Sends a message to the main worker.
+
Sends a message to main worker.
Parameters
@@ -521,13 +589,13 @@ then restore the original execution context.
Overrides AbstractWorker.sendToMainWorker
- Defined in src/worker/cluster-worker.ts:52

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

setDefaultTaskFunction

setDefaultTaskFunction(name): boolean
-
Sets the default task function to use when no task function name is specified.
+
Sets the default task function to use in the worker.

Parameters
@@ -548,7 +616,7 @@ then restore the original execution context.
Inherited from AbstractWorker.setDefaultTaskFunction
- Defined in src/worker/abstract-worker.ts:237

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

triggerAsyncId

`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

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

`Static` bind

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

fn: TaskAsyncFunction<Data, Response>

task: Task<Data>

fn: TaskSyncFunction<Data, Response>

task: Task<Data>