AbstractWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=e75fee8f4ccdbae38510e1a4755788b16ce7892b;hb=31542ddfe8297d3bd0f9cf97a3de06a03dafc15d;hp=485faa133169a8317e1a215536ea463b4323375f;hpb=f38f85c043864b68ea519f6bdf94821c356195f1;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 485faa13..e75fee8f 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -AbstractWorker | poolifier - v2.6.12

+AbstractWorker | poolifier - v2.6.32

@@ -47,7 +47,7 @@

ClusterWorker

ThreadWorker

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

@@ -59,22 +59,25 @@

Properties

aliveInterval? +

activeInterval? id isMain lastTaskTimestamp -mainWorker +mainWorker opts statistics taskFunctions

@@ -98,7 +109,7 @@

constructor

new AbstractWorker<MainWorker, Data, Response>(type, isMain, taskFunctions, mainWorker, opts?): AbstractWorker<MainWorker, Data, Response>
new AbstractWorker<MainWorker, Data, Response>(type, isMain, mainWorker, taskFunctions, opts?): AbstractWorker<MainWorker, Data, Response>
Constructs a new poolifier worker.

@@ -106,7 +117,7 @@
Type Parameters
- -
  MainWorker extends Worker | MessagePort
- Data = unknown
- @@ -125,17 +136,17 @@
- -
  taskFunctions: WorkerFunction<Data, Response> | TaskFunctions<Data, Response>
  -
  Task function(s) processed by the worker when the pool's execution function is invoked. The first function is the default function.
  +
  mainWorker: MainWorker
  +
  Reference to main worker.
- -
  mainWorker: MainWorker
  -
  Reference to main worker.
  +
  taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
  +
  Task function(s) processed by the worker when the pool's execution function is invoked. The first function is the default function.
- -
  opts: WorkerOptions = ...
  +
  opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
  
  Options for the worker.
@@ -143,17 +154,17 @@
Overrides AsyncResource.constructor
- Defined in src/worker/abstract-worker.ts:68

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

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

`Protected` `Abstract` id

id: number

@@ -161,7 +172,7 @@

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

`Protected` `Readonly` isMain

isMain: boolean

@@ -169,7 +180,7 @@

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

@@ -177,23 +188,23 @@

`Protected` `Readonly` mainWorker

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

`Private` `Readonly` mainWorker

mainWorker: MainWorker

Reference to main worker.

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

`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

@@ -201,17 +212,49 @@

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

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.
+
+
- Defined in src/worker/abstract-worker.ts:183

asyncId

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

`Private` beginTaskPerformance

beginTaskPerformance(): TaskPerformance
beginTaskPerformance(name?): TaskPerformance
+
+
Parameters
+
- +
  Optional name: string
Returns TaskPerformance
- Defined in src/worker/abstract-worker.ts:337

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

bind

`Private` checkAlive

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

`Private` checkActive

checkAlive(): void
checkActive(): void
Checks if the worker should be terminated, because its living too long.

Returns void
- Defined in src/worker/abstract-worker.ts:205

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

`Private` checkMessageWorkerId

checkMessageWorkerId(message): void
+
Check if the message worker id is set and matches the worker id.
+
+
+
Parameters
+
- +
  message: MessageValue<Data, unknown>
  +
  The message to check.
  +
  +
+
Returns void
+
+
Throws
https://nodejs.org/api/errors.html#class-error If the message worker id is not set or does not match the worker id.
+
+
- Defined in src/worker/abstract-worker.ts:375

`Private` checkStatistics

Returns void
- Defined in src/worker/abstract-worker.ts:360

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

`Private` checkTaskFunctionName

checkTaskFunctionName(name): void
+
+
Parameters
+
- +
  name: string
+
Returns void
+
- Defined in src/worker/abstract-worker.ts:298

`Private` checkTaskFunctions

Parameters

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

The task function(s) parameter that should be checked.

Returns void

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

`Private` checkWorkerOptions

opts: WorkerOptions

Returns void

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

emitDestroy

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

`Private` endTaskPerformance

taskPerformance: TaskPerformance

Returns TaskPerformance

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

`Protected` getMainWorker

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

`Private` getTaskFunction

getTaskFunction(name?): WorkerFunction<Data, Response>
getTaskFunction(name?): TaskFunction<Data, Response>
-
Gets the task function in the given scope.
+
Gets the task function with the given name.
Parameters
- Optional name: string
  -
  Name of the function that will be returned.
  +
  Name of the task function that will be returned.
-
Returns WorkerFunction<Data, Response>
-
+
Returns TaskFunction<Data, Response>
The task function.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-error If the task function is not found.
+
- Defined in src/worker/abstract-worker.ts:328

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

`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
+
+
- Defined in src/worker/abstract-worker.ts:341

`Protected` `Abstract` handleReadyMessage

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

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.
+
+
- 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.
+ +
+
- 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:319

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.
+
+
- 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.
+
+
- Defined in src/worker/abstract-worker.ts:465

`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
- Defined in src/worker/abstract-worker.ts:288

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

runInAsyncScope

Defined in node_modules/.pnpm/@types+node@20.5.3/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
- Defined in src/worker/abstract-worker.ts:251

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

`Protected` sendTaskFunctionsListToMainWorker

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

`Protected` `Abstract` sendToMainWorker

sendToMainWorker(message): void
-
Sends a message to the main worker.
+
Sends a message to main worker.
Parameters
@@ -529,29 +744,55 @@ then restore the original execution context.

Returns void
- Defined in src/worker/abstract-worker.ts:231

`Private` startCheckAlive

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

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.
+
+
- Defined in src/worker/abstract-worker.ts:275

`Private` startCheckActive

startCheckAlive(): void
startCheckActive(): void
-
Starts the worker alive check interval.
+
Starts the worker check active interval.

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

`Private` stopCheckAlive

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

`Private` stopCheckActive

stopCheckAlive(): void
stopCheckActive(): void
-
Stops the worker alive check interval.
+
Stops the worker check active interval.

Returns void
- Defined in src/worker/abstract-worker.ts:198

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

triggerAsyncId

`Protected` workerReady

workerReady(): void
Defined in node_modules/.pnpm/@types+node@20.5.3/node_modules/@types/node/async_hooks.d.ts:311

`Private` updateLastTaskTimestamp

updateLastTaskTimestamp(): void
-
Notifies the main worker that this worker is ready to process tasks.
-
-
Returns void
-
+
Returns void
- Defined in src/worker/abstract-worker.ts:179

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

`Static` bind

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

MainWorker extends Worker | MessagePort

Data = unknown

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

mainWorker: MainWorker

mainWorker: MainWorker

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

opts: WorkerOptions = ...

opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

name: string

fn: TaskFunction<Data, Response>

`Optional` name: string

message: MessageValue<Data, unknown>

name: string

`Optional` name: string

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>

task: Task<Data>

fn: WorkerSyncFunction<Data, Response>

fn: TaskSyncFunction<Data, Response>

message: MessageValue<Data, unknown>

task: Task<Data>

name: string