ClusterWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FClusterWorker.html;h=5e4695d89e4f3790d9e4414a1e558abab53c00ee;hb=85003dff831b309b12d624215a8d67634af82b50;hp=f0cdd40c873da0fce4161c6ce0659a0bb225e57a;hpb=a6b5c73ccccb3ef0ccc24ad462182e3cacee77b4;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index f0cdd40c..5e4695d8 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -ClusterWorker | poolifier - v2.6.9

+ClusterWorker | poolifier - v2.6.14

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

ClusterWorker

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

@@ -73,17 +73,23 @@ but the minimum number of workers will be guaranteed.

Methods

asyncId +

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

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

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

Properties

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

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

`Protected` `Readonly` isMain

isMain: boolean

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

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

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

@@ -157,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 = ...

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

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

`Protected` statistics

statistics: WorkerStatistics

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

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

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

Accessors

@@ -198,9 +204,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:177

asyncId

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

bind

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

`Protected` handleError

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

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

`Protected` messageListener

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

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

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

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

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

runInAsyncScope

Defined in node_modules/.pnpm/@types+node@20.4.1/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.
  +
  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:237

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

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

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

`Static` bind

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

task: Task<Data>

task: Task<Data>