AbstractWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=0bff1fea2c9116f75a456473e502ee05fb96170b;hb=296cba79ddbf15e2fd8510a4ba1ef0079ef77ee1;hp=c612763d4b2910504cd1652a2ce65ecb801604a2;hpb=52d3ec6b2aea8279b0ac670bd6291efa90466a60;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index c612763d..0bff1fea 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,4 +1,4 @@ -AbstractWorker | poolifier

+AbstractWorker | poolifier - v2.6.14

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

ClusterWorker

ThreadWorker

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

@@ -60,6 +60,7 @@

Properties

aliveInterval? +id isMain lastTaskTimestamp mainWorker @@ -69,10 +70,11 @@

@@ -139,17 +148,25 @@

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

Properties

`Protected` `Optional` `Readonly` aliveInterval

`Protected` `Optional` aliveInterval

aliveInterval?: Timeout

Handler id of the aliveInterval worker alive check.

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

`Protected` `Abstract` id

id: number

Worker id.

`Protected` `Readonly` isMain

isMain: boolean

@@ -157,7 +174,7 @@

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

@@ -165,15 +182,15 @@

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

`Protected` mainWorker

`Protected` `Readonly` mainWorker

mainWorker: MainWorker

Reference to main worker.

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

`Protected` `Readonly` opts

opts: WorkerOptions = ...

@@ -181,7 +198,7 @@

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

`Protected` statistics

statistics: WorkerStatistics

@@ -189,7 +206,7 @@

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

`Protected` taskFunctions

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

@@ -197,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:177

asyncId

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

`Private` beginTaskPerformance

beginTaskPerformance(): TaskPerformance
beginTaskPerformance(name?): TaskPerformance
+
+
Parameters
+
- +
  Optional name: string
Returns TaskPerformance
- Defined in src/worker/abstract-worker.ts:295

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

bind

`Protected` checkAlive

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

`Private` checkAlive

checkAlive(): void
Checks if the worker should be terminated, because its living too long.
@@ -256,7 +310,7 @@
Returns void
- Defined in src/worker/abstract-worker.ts:192

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

`Private` checkStatistics

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

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

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

`Protected` getMainWorker

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

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

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

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

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

`Protected` messageListener

Returns void

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

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

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

`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, unknown>
  -
  Input data for the given function.
  +
  task: Task<Data>
  +
  Input data for the task function.
Returns void
- Defined in src/worker/abstract-worker.ts:250

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

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, unknown>
  -
  Input data for the given function.
  +
  task: Task<Data>
  +
  Input data for the task function.
Returns void
- Defined in src/worker/abstract-worker.ts:217

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

`Protected` `Abstract` sendToMainWorker

Returns void

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

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

`Private` startCheckAlive

startCheckAlive(): void
+
Starts the worker alive check interval.
+
+
Returns void
+
+
- Defined in src/worker/abstract-worker.ts:308

`Private` stopCheckAlive

stopCheckAlive(): void
+
Stops the worker alive check interval.
+
+
Returns void
+
+
- Defined in src/worker/abstract-worker.ts:320

triggerAsyncId

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

`Protected` workerReady

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

`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

Properties

Methods

name: string

fn: WorkerFunction<Data, Response>

`Optional` name: string

`Optional` name: string

name: string

name: string

task: Task<Data>

fn: WorkerAsyncFunction<Data, Response>

message: MessageValue<Data, unknown>

task: Task<Data>

fn: WorkerSyncFunction<Data, Response>

message: MessageValue<Data, unknown>

task: Task<Data>

name: string