ClusterWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FClusterWorker.html;h=d55a97e12a1bc0958da4989d22fed9890e1e5f45;hb=969223ea18802a84dfea369e254332e11bf8e419;hp=19af66cab32cb8d6049a0456988d5ee8fd69bf2d;hpb=36df5bd40369d98d6ccb60400e66dce1aa980d54;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 19af66ca..d55a97e1 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -ClusterWorker | poolifier - v2.6.15

+ClusterWorker | poolifier - v2.6.33

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

ClusterWorker

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

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

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

emitDestroy getMainWorker handleError +handleKillMessage +handleReadyMessage hasTaskFunction +listTaskFunctions messageListener removeTaskFunction run runAsync runInAsyncScope runSync -sendReadyResponse +sendTaskFunctionsListToMainWorker sendToMainWorker setDefaultTaskFunction triggerAsyncId @@ -112,7 +114,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

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

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

`Protected` `Readonly` isMain

isMain: boolean

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

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

@@ -154,25 +156,16 @@ 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:65

`Protected` `Readonly` opts

opts: WorkerOptions = ...

`Protected` opts

opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

Options for the worker.

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

`Protected` statistics

statistics: WorkerStatistics

@@ -181,16 +174,16 @@ but the minimum number of workers will be guaranteed.

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

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

Accessors

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

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

Methods

@@ -224,14 +217,14 @@ 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.

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-typeerror If the name parameter is not a string or an empty string.

Throws

https://nodejs.org/api/errors.html#class-error If the name parameter is the default task function reserved name.

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

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

asyncId

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

bind

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

emitDestroy

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

`Protected` getMainWorker

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

`Protected` handleError

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

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

`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

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.

Throws

https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.

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

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: MessageValue<Data, unknown>

The received message.

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

removeTaskFunction

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-typeerror If the name parameter is not a string or an empty string.

Throws

https://nodejs.org/api/errors.html#class-error If the name parameter is the default task function reserved name.

@@ -397,7 +443,7 @@ never be called.

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

`Protected` run

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

`Protected` runAsync

Parameters

-
fn: WorkerAsyncFunction<Data, Response>
+
fn: TaskAsyncFunction<Data, Response>

Task function that will be executed.

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

runInAsyncScope

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

`Protected` runSync

Parameters

-
fn: WorkerSyncFunction<Data, Response>
+
fn: TaskSyncFunction<Data, Response>

Task function that will be executed.

`Protected` sendReadyResponse

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

`Protected` sendTaskFunctionsListToMainWorker

sendReadyResponse(): void
sendTaskFunctionsListToMainWorker(): void
-
Sends the ready response to the main worker.
+
Sends the list of task function names to the main worker.

Returns void
-
Inherited from AbstractWorker.sendReadyResponse
+
Inherited from AbstractWorker.sendTaskFunctionsListToMainWorker
- Defined in src/worker/abstract-worker.ts:308

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

`Protected` sendToMainWorker

sendToMainWorker(message): void
-
Sends a message to the main worker.
+
Sends a message to main worker.
Parameters
@@ -556,13 +602,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:70

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
@@ -575,7 +621,7 @@ then restore the original execution context.

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-typeerror If the name parameter is not a string or an empty string.

Throws
https://nodejs.org/api/errors.html#class-error If the name parameter is the default task function reserved name.
@@ -583,7 +629,7 @@ then restore the original execution context.
Inherited from AbstractWorker.setDefaultTaskFunction
- Defined in src/worker/abstract-worker.ts:253

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

triggerAsyncId

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

`Static` bind

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

taskFunctions: WorkerFunction<Data, Response> | TaskFunctions<Data, Response>

taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>