AbstractWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=inline;f=docs%2Fclasses%2FAbstractWorker.html;h=0683a5af336cdebcc505b70b02630e15e2f13dfb;hb=8735b4e51c0cfabc9612d57417834d42042cab4e;hp=c4da792dfd210020c6d059c52cf65adc5eb494aa;hpb=15d6dfaf877ec6a99e2bde48cb3c8a9e8671c075;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index c4da792d..0683a5af 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -AbstractWorker | poolifier

+AbstractWorker | poolifier - v2.6.29

@@ -29,12 +29,12 @@

Data = unknown

Type of data this worker receives from pool's execution. This can only be serializable data.

Type of data this worker receives from pool's execution. This can only be structured-cloneable data.

Response = unknown

Type of response the worker sends back to the main worker. This can only be serializable data.

Type of response the worker sends back to the main worker. This can only be structured-cloneable data.

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

ClusterWorker

ThreadWorker

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

@@ -59,30 +59,48 @@

Properties

aliveInterval? +

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

@@ -90,7 +108,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.

@@ -98,7 +116,7 @@
Type Parameters
- -
  MainWorker extends Worker | MessagePort
- Data = unknown
- @@ -117,17 +135,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: undefined | null | 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.
@@ -135,17 +153,25 @@
Overrides AsyncResource.constructor
- Defined in src/worker/abstract-worker.ts:55

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

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` `Abstract` id

id: number

Worker id.

`Protected` `Readonly` isMain

isMain: boolean

@@ -153,7 +179,7 @@

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

@@ -161,33 +187,73 @@

`Protected` mainWorker

mainWorker: undefined | null | 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

Performance statistics computation requirements.

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

asyncId

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

`Private` beginTaskPerformance

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

bind

`Protected` checkAlive

checkAlive(): void
Defined in node_modules/.pnpm/@types+node@20.5.1/node_modules/@types/node/async_hooks.d.ts:283

`Private` checkActive

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

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

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

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

`Private` checkStatistics

checkStatistics(): void
+
Returns void
+
- Defined in src/worker/abstract-worker.ts:603

`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.1/node_modules/@types/node/async_hooks.d.ts:302

`Private` endTaskPerformance

endTaskPerformance(taskPerformance): TaskPerformance
+
+
Parameters
+
- +
  taskPerformance: TaskPerformance
+
Returns TaskPerformance
+
- Defined in src/worker/abstract-worker.ts:588

`Protected` getMainWorker

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

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

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

`Protected` handleError

The error raised by the worker.

Returns string

Message of the error.

Returns string

The error message.

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

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

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

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

`Protected` messageListener

Parameters

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

Returns void

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

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: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.
+
+
- 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.
  +
  fn: TaskAsyncFunction<Data, Response>
  +
  Task function that will be executed.
- -
  message: MessageValue<Data, Worker | MessagePort>
  -
  Input data for the given function.
  +
  task: Task<Data>
  +
  Input data for the task function.
Returns void
- Defined in src/worker/abstract-worker.ts:240

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

runInAsyncScope

Defined in node_modules/.pnpm/@types+node@20.5.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.
  +
  fn: TaskSyncFunction<Data, Response>
  +
  Task function that will be executed.
- -
  message: MessageValue<Data, Worker | MessagePort>
  -
  Input data for the given function.
  +
  task: Task<Data>
  +
  Input data for the task function.
Returns void
- Defined in src/worker/abstract-worker.ts:207

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

`Protected` sendTaskFunctionsListToMainWorker

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

`Protected` `Abstract` sendToMainWorker

sendToMainWorker(message): void
-
Sends a message to the main worker.
+
Sends a message to main worker.
Parameters
- -
  message: MessageValue<Response, Worker | MessagePort>
  +
  message: MessageValue<Response, Data>
  
  The response message.
Returns void
- Defined in src/worker/abstract-worker.ts:177

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

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

`Private` startCheckActive

startCheckActive(): void
+
Starts the worker check active interval.
+
+
Returns void
+
+
- Defined in src/worker/abstract-worker.ts:399

`Private` stopCheckActive

stopCheckActive(): void
+
Stops the worker check active interval.
+
+
Returns void
+
+
- Defined in src/worker/abstract-worker.ts:410

triggerAsyncId

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

`Private` updateLastTaskTimestamp

updateLastTaskTimestamp(): void
+
Returns void
+
- Defined in src/worker/abstract-worker.ts:609

`Static` bind

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

WorkerTypes

availableParallelism

Generated using TypeDoc

\ No newline at end of file

MainWorker extends Worker | MessagePort

Data = unknown

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

mainWorker: MainWorker

mainWorker: undefined | null | 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>

taskPerformance: TaskPerformance

`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, Worker | MessagePort>

task: Task<Data>

fn: WorkerSyncFunction<Data, Response>

fn: TaskSyncFunction<Data, Response>

message: MessageValue<Data, Worker | MessagePort>

task: Task<Data>

message: MessageValue<Response, Worker | MessagePort>

message: MessageValue<Response, Data>

name: string