ThreadWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FThreadWorker.html;h=ee75a3704c6be18b99b12c054b362e8f0ee6f026;hb=5e972953bf3193a557a14fa794d559b2acc1d6de;hp=d247ec0492c4922e295bb3a1787483a69e910e18;hpb=68887e30ceca3df78b70e0b8f1b262a76f2d7cd8;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index d247ec04..ee75a370 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,4 +1,4 @@ -ThreadWorker | poolifier - v2.6.12

+ThreadWorker | poolifier - v2.6.18

@@ -47,7 +47,7 @@ but the minimum number of workers will be guaranteed.

ThreadWorker

Defined in src/worker/thread-worker.ts:26

@@ -59,7 +59,7 @@ but the minimum number of workers will be guaranteed.

Properties

aliveInterval? +

activeInterval? isMain lastTaskTimestamp mainWorker @@ -80,15 +80,17 @@ but the minimum number of workers will be guaranteed.

getMainWorker handleError hasTaskFunction +listTaskFunctions messageListener removeTaskFunction +run runAsync runInAsyncScope runSync +sendReadyResponse sendToMainWorker setDefaultTaskFunction triggerAsyncId -workerReady bind

@@ -124,18 +126,18 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/thread-worker.ts:36

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

`Protected` `Readonly` isMain

isMain: boolean

@@ -144,7 +146,7 @@ but the minimum number of workers will be guaranteed.

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

@@ -153,7 +155,7 @@ but the minimum number of workers will be guaranteed.

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

`Protected` `Readonly` mainWorker

mainWorker: MessagePort

@@ -162,7 +164,7 @@ but the minimum number of workers will be guaranteed.

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

`Protected` `Readonly` opts

opts: WorkerOptions = ...

@@ -171,7 +173,7 @@ but the minimum number of workers will be guaranteed.

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

`Protected` statistics

statistics: WorkerStatistics

@@ -180,7 +182,7 @@ but the minimum number of workers will be guaranteed.

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

`Protected` taskFunctions

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

@@ -189,7 +191,7 @@ but the minimum number of workers will be guaranteed.

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

Accessors

@@ -203,7 +205,7 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/thread-worker.ts:51

Methods

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

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

asyncId

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

bind

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

emitDestroy

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

listTaskFunctions

listTaskFunctions(): string[]
+
Lists the names of the worker's task functions.
+
+
Returns string[]
The names of the worker's task functions.
+ +
+
Inherited from AbstractWorker.listTaskFunctions
+
- Defined in src/worker/abstract-worker.ts:249

`Protected` messageListener

message: MessageValue<Data, Data>
-
Message received.
+
The received message.

Returns void

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

removeTaskFunction

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

`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.
+
+
Inherited from AbstractWorker.run
+
- Defined in src/worker/abstract-worker.ts:393

`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
Inherited from AbstractWorker.runAsync
- Defined in src/worker/abstract-worker.ts:410

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

runInAsyncScope

Defined in node_modules/.pnpm/@types+node@20.4.2/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
Inherited from AbstractWorker.runSync
- Defined in src/worker/abstract-worker.ts:372

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

`Protected` sendReadyResponse

sendReadyResponse(): void
+
Sends the ready response to the main worker.
+
+
Returns void
+
+
Inherited from AbstractWorker.sendReadyResponse
+
- Defined in src/worker/abstract-worker.ts:319

`Protected` sendToMainWorker

Defined in src/worker/thread-worker.ts:56

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
@@ -548,7 +597,7 @@ then restore the original execution context.
Inherited from AbstractWorker.setDefaultTaskFunction
- Defined in src/worker/abstract-worker.ts:237

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

triggerAsyncId

`Protected` workerReady

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

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

`Static` bind

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

task: Task<Data>

task: Task<Data>