ThreadWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FThreadWorker.html;h=2fcb0676ff5da98ccf5efbd2b54726b884d54492;hb=adab53c70d781f8c26e35b7359efa3d05c278fa8;hp=bd7cbabcbb4aeba6822b9c90262425cdc956602c;hpb=a15339d10554e3130fa1d8957163cb29a8eb2c41;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index bd7cbabc..2fcb0676 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,4 +1,4 @@ -ThreadWorker | poolifier - v2.6.12

+ThreadWorker | poolifier - v2.6.39

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

ThreadWorker

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

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

Properties

aliveInterval? +

activeInterval? isMain lastTaskTimestamp -mainWorker opts +port statistics taskFunctions

@@ -79,17 +79,20 @@ but the minimum number of workers will be guaranteed.

emitDestroy getMainWorker handleError +handleKillMessage +handleReadyMessage hasTaskFunction +listTaskFunctions messageListener removeTaskFunction run runAsync runInAsyncScope runSync +sendTaskFunctionsListToMainWorker sendToMainWorker setDefaultTaskFunction triggerAsyncId -workerReady bind

@@ -112,31 +115,29 @@ but the minimum number of workers will be guaranteed.

Parameters

-
taskFunctions: WorkerFunction<Data, Response> | TaskFunctions<Data, Response>
+
taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>

Task function(s) processed by the worker when the pool's execution function is invoked.
-
-
opts: WorkerOptions = {}

Options for the worker.
-
-

Returns ThreadWorker<Data, Response>

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

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

isMain: boolean

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

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

@@ -154,25 +155,24 @@ but the minimum number of workers will be guaranteed.

`Protected` `Readonly` mainWorker

mainWorker: MessagePort

Reference to main worker.

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

`Protected` `Readonly` opts

opts: WorkerOptions = ...

`Protected` opts

opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

Options for the worker.

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

`Private` port

port: MessagePort

Message port used to communicate with the main worker.

`Protected` statistics

statistics: WorkerStatistics

@@ -181,16 +181,16 @@ but the minimum number of workers will be guaranteed.

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

Accessors

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

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

Methods

@@ -221,17 +221,15 @@ If a task function with the same name already exists, it is replaced.

name: string

The name of the task function to add.

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.

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

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

asyncId

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

bind

fn: Func

The function to bind to the current AsyncResource.
-
-

Returns Func

Since

v14.8.0, v12.19.0

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

emitDestroy

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

`Protected` getMainWorker

Returns MessagePort

Reference to the main worker.

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

`Protected` handleError

e: string | Error

The error raised by the worker.
-
-

Returns string

The error message.

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

`Protected` handleKillMessage

handleKillMessage(message): void
+
Handles a kill message sent by the main worker.
+
+
+
Parameters
+
- +
  message: MessageValue<Data, unknown>
  +
  The kill message.
  +
+
Returns void
+
+
Overrides AbstractWorker.handleKillMessage
+
- Defined in src/worker/thread-worker.ts:79

`Protected` handleReadyMessage

handleReadyMessage(message): void
+
Handles the ready message sent by the main worker.
+
+
+
Parameters
+
- +
  message: MessageValue<Data, unknown>
  +
  The ready message.
  +
+
Returns void
+
+
Overrides AbstractWorker.handleReadyMessage
+
- Defined in src/worker/thread-worker.ts:54

hasTaskFunction

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.

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

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

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

removeTaskFunction

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

@@ -397,7 +443,7 @@ never be called.

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

`Protected` run

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

`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.
  -
  -
task: Task<Data>

Input data for the task function.
-
-

Returns void

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

runInAsyncScope

fn: ((this, ...args) => Result)

The function to call in the execution context of this async resource.

- this: This
- -
  Rest ...args: any[]
+
Rest ...args: any[]
Rest

Returns Result

`Optional` thisArg: This

The receiver to be used for the function call.

+Optional

`Rest` ...args: any[]

Optional arguments to pass to the function.

+Rest

Returns Result

Since

v9.6.0

Defined in node_modules/.pnpm/@types+node@20.5.7/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.
  -
  -
task: Task<Data>

Input data for the task function.
-
-

Returns void

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

`Protected` sendTaskFunctionsListToMainWorker

sendTaskFunctionsListToMainWorker(): void
+
Sends the list of task function names to the main worker.
+
+
Returns void
+
+
Inherited from AbstractWorker.sendTaskFunctionsListToMainWorker
+
- Defined in src/worker/abstract-worker.ts:453

`Protected` sendToMainWorker

sendToMainWorker(message): void
-
Sends a message to the main worker.
+
Sends a message to main worker.

Parameters
@@ -538,19 +588,18 @@ then restore the original execution context.
message: MessageValue<Response, unknown>

The response message.
-
-

Returns void

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

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
@@ -558,12 +607,11 @@ then restore the original execution context.
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-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.

@@ -571,7 +619,7 @@ then restore the original execution context.

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

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

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

`Static` bind

fn: Func

The function to bind to the current execution context.
-
-
Optional type: string

An optional name to associate with the underlying AsyncResource.
-
-

Optional

-
Optional thisArg: ThisArg

`Optional` thisArg: ThisArg

Optional

Returns Func

Since

v14.8.0, v12.19.0

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

Generated using TypeDoc

\ No newline at end of file