AbstractWorker | poolifier

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

+AbstractWorker | poolifier - v2.6.29

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

ClusterWorker

ThreadWorker

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

@@ -75,6 +75,7 @@ beginTaskPerformance bind checkActive +checkMessageWorkerId checkStatistics checkTaskFunctions checkWorkerOptions @@ -93,6 +94,7 @@ runAsync runInAsyncScope runSync +sendTaskFunctionsListToMainWorker sendToMainWorker setDefaultTaskFunction startCheckActive @@ -143,7 +145,7 @@

opts: WorkerOptions = ...

opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

Options for the worker.

@@ -151,7 +153,7 @@

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

Properties

@@ -161,7 +163,7 @@

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

`Protected` `Abstract` id

id: number

@@ -169,7 +171,7 @@

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

`Protected` `Readonly` isMain

isMain: boolean

@@ -177,7 +179,7 @@

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

@@ -185,7 +187,7 @@

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

`Private` `Readonly` mainWorker

mainWorker: MainWorker

@@ -193,15 +195,15 @@

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

@@ -209,7 +211,7 @@

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

`Protected` taskFunctions

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

@@ -217,7 +219,7 @@

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

Methods

@@ -244,14 +246,14 @@ If a task function with the same name already exists, it is replaced.

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

`Optional` name: string

Returns TaskPerformance

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

bind

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

`Private` checkActive

Returns void

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

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

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

`Private` checkTaskFunctions

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

taskPerformance: TaskPerformance

Returns TaskPerformance

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

`Protected` getMainWorker

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

`Private` getTaskFunction

Throws

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

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

`Protected` handleError

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

`Protected` handleKillMessage

Returns void

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

`Protected` `Abstract` handleReadyMessage

Returns void

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

hasTaskFunction

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.

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

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

`Protected` messageListener

Returns void

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

removeTaskFunction

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

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

Returns void

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

Returns void

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

Returns void

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

setDefaultTaskFunction

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

Returns void

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

`Private` stopCheckActive

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

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

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