AbstractWorker | poolifier

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

+AbstractWorker | poolifier - v2.6.32

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

ClusterWorker

ThreadWorker

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

@@ -75,7 +75,9 @@ beginTaskPerformance bind checkActive +checkMessageWorkerId checkStatistics +checkTaskFunctionName checkTaskFunctions checkWorkerOptions emitDestroy @@ -93,6 +95,7 @@ runAsync runInAsyncScope runSync +sendTaskFunctionsListToMainWorker sendToMainWorker setDefaultTaskFunction startCheckActive @@ -143,7 +146,7 @@

opts: WorkerOptions = ...

opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

Options for the worker.

@@ -151,7 +154,7 @@

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

Properties

@@ -161,7 +164,7 @@

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

`Protected` `Abstract` id

id: number

@@ -169,7 +172,7 @@

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

`Protected` `Readonly` isMain

isMain: boolean

@@ -177,7 +180,7 @@

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

@@ -185,7 +188,7 @@

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

`Private` `Readonly` mainWorker

mainWorker: MainWorker

@@ -193,15 +196,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 +212,7 @@

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

`Protected` taskFunctions

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

@@ -217,7 +220,7 @@

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

Methods

@@ -244,14 +247,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:183

asyncId

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

`Private` beginTaskPerformance

`Optional` name: string

Returns TaskPerformance

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

bind

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

`Private` checkActive

Returns void

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

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

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

Throws

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

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

`Protected` handleError

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

`Protected` handleKillMessage

Returns void

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

`Protected` `Abstract` handleReadyMessage

Returns void

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

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

`Protected` messageListener

Returns void

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

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

`Protected` runAsync

Returns void

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

Returns void

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

Returns void

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

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

`Private` startCheckActive

Returns void

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

`Private` stopCheckActive

Returns void

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

triggerAsyncId

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

`Static` bind

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