ClusterWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FClusterWorker.html;h=457a1629048a65fd910a22928e02f97785737058;hb=dd7dfcc292a646940f5f0263d24d8f5f528e8a51;hp=cd1eb284485819910af3047a05825f4590fbe4df;hpb=030eb5a38e62c6e381961644eab2ddac9a027aea;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index cd1eb284..457a1629 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -ClusterWorker | poolifier

+ClusterWorker | poolifier - v2.6.37

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

ClusterWorker

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

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

Properties

aliveInterval? +

activeInterval? isMain lastTaskTimestamp -mainWorker opts statistics taskFunctions

Accessors

id +

@@ -103,31 +114,29 @@ 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.
-
-
opts: WorkerOptions = {}

Options for the worker.
-
-

Returns ClusterWorker<Data, Response>

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

Properties

`Protected` `Optional` `Readonly` 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:73

`Protected` `Readonly` isMain

isMain: boolean

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

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

@@ -145,25 +154,16 @@ but the minimum number of workers will be guaranteed.

`Protected` 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

@@ -172,18 +172,63 @@ 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

`Protected` id

get id(): number
+
Worker id.
+
+
Returns number
+
+
Overrides AbstractWorker.id
+
- Defined in src/worker/cluster-worker.ts:65

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: 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 or an empty 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:193

asyncId

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

bind

fn: Func

The function to bind to the current AsyncResource.
-
-

Returns Func

Since

v14.8.0, v12.19.0

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

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

emitDestroy

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

`Protected` getMainWorker

Returns Worker

Reference to the main worker.

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

`Protected` handleError

handleError(e): string
Handles an error and convert it to a string so it can be sent back to the main worker.
@@ -276,14 +310,86 @@ never be called.
e: string | Error

The error raised by the worker.
+

Returns string

The error message.

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

`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

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 or an empty string.
+
+
Inherited from AbstractWorker.hasTaskFunction
+
- Defined in src/worker/abstract-worker.ts:177

listTaskFunctions

listTaskFunctions(): string[]
+
Lists the names of the worker's task functions.

-

Returns string

Message of the error.

Returns string[]

The names of the worker's task functions.

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

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

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 or an empty 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:231

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

`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.
  -
  -
- -
  message: MessageValue<Data, unknown>
  -
  Input data for the given function.
  -
  -
+
task: Task<Data>
+
Input data for the task function.
+

Returns void

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

runInAsyncScope

fn: ((this, ...args) => Result)

The function to call in the execution context of this async resource.

- this: This
- -
  Rest ...args: any[]
+
Rest ...args: any[]
Rest

Returns Result

`Optional` thisArg: This

The receiver to be used for the function call.

+Optional

`Rest` ...args: any[]

Optional arguments to pass to the function.

+Rest

Returns Result

Since

v9.6.0

Defined in node_modules/.pnpm/@types+node@20.5.7/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.
  -
  -
- -
  message: MessageValue<Data, unknown>
  -
  Input data for the given function.
  -
  -
+
task: Task<Data>
+
Input data for the task function.
+

Returns void

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

`Protected` sendTaskFunctionsListToMainWorker

sendTaskFunctionsListToMainWorker(): void
+
Sends the list of task function names to the main worker.
+
+
Returns void
+
+
Inherited from AbstractWorker.sendTaskFunctionsListToMainWorker
+
- Defined in src/worker/abstract-worker.ts:453

`Protected` sendToMainWorker

sendToMainWorker(message): void
-
Sends a message to the main worker.
+
Sends a message to main worker.

Parameters
@@ -422,13 +579,38 @@ then restore the original execution context.
message: MessageValue<Response, unknown>

The response message.
-
-

Returns void

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

setDefaultTaskFunction

setDefaultTaskFunction(name): boolean
+
Sets the default task function to use in the worker.
+
+
+
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 or an empty 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:285

triggerAsyncId

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

`Static` bind

fn: Func

The function to bind to the current execution context.
-
-
Optional type: string

An optional name to associate with the underlying AsyncResource.
-
-

Optional

-
Optional thisArg: ThisArg

`Optional` thisArg: ThisArg

Optional

Returns Func

Since

v14.8.0, v12.19.0

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

WorkerTypes

availableParallelism

Generated using TypeDoc

\ No newline at end of file

name: string

fn: TaskFunction<Data, Response>

message: MessageValue<Data, unknown>

message: MessageValue<Data, unknown>

name: string

name: string

task: Task<Data>

fn: WorkerAsyncFunction<Data, Response>

fn: TaskAsyncFunction<Data, Response>

message: MessageValue<Data, unknown>

this: This

`Rest` ...args: any[]

fn: WorkerSyncFunction<Data, Response>

fn: TaskSyncFunction<Data, Response>

message: MessageValue<Data, unknown>

name: string