AbstractWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=efc1ac916d12eb8693425297fd3e97398648b6a7;hb=c90257c0b2d2c8ebdc6abbee02361cc2ddae36b9;hp=71c0015fed848d4f0855ec42e200be72e7a953e3;hpb=f33c2d55c063a50c0025bf707fa4faf7a5e25f6e;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 71c0015f..efc1ac91 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -AbstractWorker | poolifier - v2.6.12

+AbstractWorker | poolifier - v2.6.30

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

ClusterWorker

ThreadWorker

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

@@ -59,11 +59,11 @@

@@ -103,7 +109,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 +117,7 @@
Type Parameters
- -
  MainWorker extends Worker | MessagePort
- Data = unknown
- @@ -130,17 +136,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: 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.
@@ -148,17 +154,17 @@
Overrides AsyncResource.constructor
- Defined in src/worker/abstract-worker.ts:73

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

Properties

`Protected` `Optional` 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

@@ -166,7 +172,7 @@

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

`Protected` `Readonly` isMain

isMain: boolean

@@ -174,7 +180,7 @@

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

@@ -182,23 +188,23 @@

`Protected` `Readonly` 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

@@ -206,15 +212,15 @@

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

`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

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

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.1/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

`Private` checkAlive

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

`Private` checkActive

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

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

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

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

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

taskPerformance: TaskPerformance

Returns TaskPerformance

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

`Protected` getMainWorker

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

`Private` getTaskFunction

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

@@ -407,13 +447,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:559

`Protected` handleError

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

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

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

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 received.
+
message: MessageValue<Data, unknown>
+
The received message.

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

runAsync(fn, task): void
-
Runs the given function asynchronously.
+
Runs the given task function asynchronously.
Parameters
- -
  fn: WorkerAsyncFunction<Data, Response>
  +
  fn: TaskAsyncFunction<Data, Response>
  
  Task function that will be executed.

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

runInAsyncScope

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

`Protected` runSync

runSync(fn, task): void
-
Runs the given function synchronously.
+
Runs the given task function synchronously.
Parameters
- -
  fn: WorkerSyncFunction<Data, Response>
  +
  fn: TaskSyncFunction<Data, Response>
  
  Task function that will be executed.

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

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

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

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

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
@@ -662,36 +763,36 @@ then restore the original execution context.

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

`Private` startCheckAlive

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

`Private` startCheckActive

startCheckAlive(): void
startCheckActive(): void
-
Starts the worker alive check interval.
+
Starts the worker check active interval.

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

`Private` stopCheckAlive

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

`Private` stopCheckActive

stopCheckAlive(): void
stopCheckActive(): void
-
Stops the worker alive check interval.
+
Stops the worker check active interval.

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

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

triggerAsyncId

`Protected` workerReady

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

`Private` updateLastTaskTimestamp

updateLastTaskTimestamp(): void
-
Notifies the main worker that this worker is ready to process tasks.
-
-
Returns void
-
+
Returns void
- Defined in src/worker/abstract-worker.ts:296

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

`Static` bind

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