AbstractWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=257aa4663e6328135689376365ce08e632a91f5f;hb=3c7c9bd12cf4b0cec0e0a3825c31f7cc9f3f58fe;hp=a343b9557dc4c76eabf338f0ae69fb5094ef78e2;hpb=79f98bd9040049eec047b50d2cbd0878fdc9e6f1;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index a343b955..257aa466 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -AbstractWorker | poolifier - v2.6.15

+AbstractWorker | poolifier - v2.6.21

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

ClusterWorker

ThreadWorker

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

@@ -103,7 +106,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.

@@ -111,7 +114,7 @@
Type Parameters
- -
  MainWorker extends Worker | MessagePort
- Data = unknown
- @@ -130,13 +133,13 @@
- -
  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.
- @@ -148,7 +151,7 @@
  Overrides AsyncResource.constructor
  - Defined in src/worker/abstract-worker.ts:73

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

Properties

@@ -158,7 +161,7 @@

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

`Protected` `Abstract` id

id: number

@@ -166,7 +169,7 @@

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

`Protected` `Readonly` isMain

isMain: boolean

@@ -174,7 +177,7 @@

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

@@ -182,15 +185,15 @@

`Protected` `Readonly` mainWorker

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

`Private` `Readonly` mainWorker

mainWorker: MainWorker

Reference to main worker.

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

`Protected` `Readonly` opts

opts: WorkerOptions = ...

@@ -198,7 +201,7 @@

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

`Protected` statistics

statistics: WorkerStatistics

@@ -206,15 +209,15 @@

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

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

Methods

@@ -234,7 +237,7 @@ 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.

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

Throws

https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.

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

asyncId

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

`Private` beginTaskPerformance

`Optional` name: string

Returns TaskPerformance

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

bind

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

`Private` checkActive

Returns void

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

`Private` checkStatistics

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

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

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

`Private` checkWorkerOptions

opts: WorkerOptions

Returns void

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

emitDestroy

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

`Private` endTaskPerformance

taskPerformance: TaskPerformance

Returns TaskPerformance

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

`Protected` getMainWorker

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

`Private` getTaskFunction

getTaskFunction(name?): WorkerFunction<Data, Response>
getTaskFunction(name?): TaskFunction<Data, Response>
Gets the task function with the given name.

@@ -407,13 +410,13 @@ never be called.

Name of the task function that will be returned.

Returns WorkerFunction<Data, Response>

The task function.

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

`Protected` handleError

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

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

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

hasTaskFunction

Throws

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

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

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

The received message.

Returns void

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

removeTaskFunction

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

Throws

https://nodejs.org/api/errors.html#class-error If the task function is not found.

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

`Protected` runAsync

Parameters

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

Task function that will be executed.

Returns void

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

runInAsyncScope

Defined in node_modules/.pnpm/@types+node@20.4.6/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.

Returns void

`Protected` sendReadyResponse

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

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

`Protected` `Abstract` sendToMainWorker

sendToMainWorker(message): void
-
Sends a message to the main worker.
+
Sends a message to main worker.
Parameters
@@ -654,13 +696,13 @@ then restore the original execution context.

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

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

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

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

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

`Private` startCheckActive

Returns void

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

`Private` stopCheckActive

Returns void

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

triggerAsyncId

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

`Private` updateLastTaskTimestamp

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

`Static` bind

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