AbstractWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=6ecd85f062a20f06edbed633a0c88ae250e2e1c5;hb=01a59f3ca06cff8a883c65567320e0a50aa446e3;hp=2e713469aa0884e4f035a4b248f6f4725af7c38b;hpb=4f487526a63c873d168386250b40ad8103c5a4d8;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 2e713469..6ecd85f0 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -AbstractWorker | poolifier

+AbstractWorker | poolifier - v2.6.16

@@ -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:39

@@ -59,7 +59,8 @@

Properties

aliveInterval? +

activeInterval? +id isMain lastTaskTimestamp mainWorker @@ -69,10 +70,12 @@

@@ -125,7 +135,7 @@

mainWorker: undefined | null | MainWorker

mainWorker: MainWorker

Reference to main worker.

@@ -138,17 +148,25 @@

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

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

`Protected` `Abstract` id

id: number

Worker id.

`Protected` `Readonly` isMain

isMain: boolean

@@ -156,7 +174,7 @@

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

@@ -164,15 +182,15 @@

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

`Protected` mainWorker

mainWorker: undefined | null | MainWorker

`Protected` `Readonly` mainWorker

mainWorker: MainWorker

Reference to main worker.

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

`Protected` `Readonly` opts

opts: WorkerOptions = ...

@@ -180,15 +198,15 @@

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

`Protected` statistics

statistics: WorkerStatistics

Performance statistics computation.

Performance statistics computation requirements.

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

`Protected` taskFunctions

taskFunctions: Map<string, WorkerFunction<Data, Response>>

@@ -196,9 +214,41 @@

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

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

asyncId

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

`Private` beginTaskPerformance

beginTaskPerformance(message): TaskPerformance
beginTaskPerformance(name?): TaskPerformance
Parameters
- -
  message: MessageValue<Data, Worker | MessagePort>
+
Optional name: string

Returns TaskPerformance

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

bind

`Protected` checkAlive

checkAlive(): void
Defined in node_modules/.pnpm/@types+node@20.4.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:199

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

`Private` checkStatistics

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

`Private` checkTaskFunctions

Returns void

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

`Private` checkWorkerOptions

opts: WorkerOptions

Returns void

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

emitDestroy

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

`Private` endTaskPerformance

taskPerformance: TaskPerformance

Returns TaskPerformance

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

`Protected` getMainWorker

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

`Private` getTaskFunction

getTaskFunction(name?): WorkerFunction<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 WorkerFunction<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:295

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

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

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

`Protected` messageListener

Parameters

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

Returns void

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

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

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

`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, 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:258

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

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, 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:224

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

`Protected` sendReadyResponse

sendReadyResponse(): void
+
Sends the ready response to the main worker.
+
+
Returns void
+
+
- Defined in src/worker/abstract-worker.ts:308

`Protected` `Abstract` sendToMainWorker

Parameters

-
message: MessageValue<Response, Worker | MessagePort>
+
message: MessageValue<Response, Data>

The response message.

Returns void

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

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

`Private` startCheckActive

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

`Private` stopCheckActive

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

triggerAsyncId

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

`Static` bind

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

WorkerTypes

availableParallelism

Generated using TypeDoc

\ No newline at end of file

task: Task<Data>

task: Task<Data>