X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractWorker.html;h=c3a79eecdf9d5a71e8b0258e53321f43a4f97bbf;hb=4cb259d3e1837759b8bac901d3755f1610b5ddc4;hp=960f1b1b6ee52ab3994755910e93bc43c9f1468b;hpb=7d3ed70ed3ebb6a3656041db3c6ea23a1f354616;p=poolifier.git diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 960f1b1b..c3a79eec 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,13 +1,13 @@ -AbstractWorker | poolifier

@@ -17,592 +17,918 @@

Class AbstractWorker<MainWorker, Data, Response>`Abstract`

Base class that implements some shared logic for all poolifier workers.

Type Parameters

-
MainWorker extends Worker | MessagePort
+
MainWorker extends Worker | MessagePort

Type of main worker.
-

Data = unknown

Type of data this worker receives from pool's execution. This can only be serializable data.

Data = unknown

Type of data this worker receives from pool's execution. This can only be structured-cloneable data.

Response = unknown

Type of response the worker sends back to the main worker. This can only be serializable data.

Response = unknown

Type of response the worker sends back to the main worker. This can only be structured-cloneable data.

Hierarchy

AsyncResource +
AsyncResource
- AbstractWorker
  - ClusterWorker
  - ThreadWorker

Index

Constructors

constructor +

constructor

Properties

aliveInterval? -isMain -lastTaskTimestamp -mainWorker -opts +

activeInterval? +id +isMain +lastTaskTimestamp +mainWorker +opts +statistics +taskFunctions

Constructors

constructor

new AbstractWorker<MainWorker, Data, Response>(type: string, isMain: boolean, fn: ((data: Data) => Response), mainWorker: undefined | null | MainWorker, opts?: WorkerOptions): AbstractWorker<MainWorker, Data, Response>

constructor

new AbstractWorker<MainWorker, Data, Response>(type, isMain, mainWorker, taskFunctions, opts?): AbstractWorker<MainWorker, Data, Response>
Constructs a new poolifier worker.

-
+
Type Parameters
-
+
Response = unknown

Parameters

-
type: string
+
type: string

The type of async event.
-

-
isMain: boolean
+
isMain: boolean

Whether this is the main worker or not.
-
-
fn: ((data: Data) => Response)
-
Function processed by the worker when the pool's execution function is invoked.

-
- -
  - (data: Data): Response
  - -
    -
    Parameters
    -
    - -
      data: Data
    -
    Returns Response
-
mainWorker: undefined | null | MainWorker
+
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.
-

Returns AbstractWorker<MainWorker, Data, Response>

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

Properties

`Protected` `Optional` `Readonly` aliveInterval

aliveInterval?: Timeout

Handler id of the aliveInterval worker alive check.

`Protected` `Readonly` isMain

isMain: boolean

Whether this is the main worker or not.

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

Timestamp of the last task processed by this worker.

`Protected` mainWorker

mainWorker: undefined | null | MainWorker

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

`Private` `Readonly` mainWorker

mainWorker: MainWorker

Reference to main worker.

`Protected` `Readonly` opts

opts: WorkerOptions = ...

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

`Protected` opts

opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

Options for the worker.

`Protected` statistics

statistics: WorkerStatistics

Performance statistics computation requirements.

`Protected` taskFunctions

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

asyncId

asyncId(): number

addTaskFunction

addTaskFunction(name, fn): boolean
-
-
Returns
The unique asyncId assigned to the resource.
+
Adds a task function to the worker. +If a task function with the same name already exists, it is replaced.

-
Returns number
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function to add.
  +
  +
- +
  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 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:193

asyncId

asyncId(): number
+
Returns number
The unique asyncId assigned to the resource.
+ +
Inherited from AsyncResource.asyncId
- Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:315

bind

bind<Func>(fn: Func): Func & {
Â Â Â Â asyncResource: AsyncResource;
}
Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/async_hooks.d.ts:306

`Private` beginTaskPerformance

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

bind

bind<Func>(fn): Func
Binds the given function to execute to this AsyncResource's scope.
-
The returned function will have an asyncResource property referencing -the AsyncResource to which the function is bound.
- -
Since
v14.8.0, v12.19.0

-
+
Type Parameters
-
+
Func extends ((...args) => any)

Parameters

-
fn: Func
+
fn: Func

The function to bind to the current AsyncResource.
-

Returns Func & {
Â Â Â Â asyncResource: AsyncResource;
}

`Protected` checkAlive

checkAlive(): void
Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/async_hooks.d.ts:283

`Private` checkActive

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

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

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

`Private` checkStatistics

checkStatistics(): void
+
Returns void
+
- Defined in src/worker/abstract-worker.ts:600

`Private` checkTaskFunctionName

checkTaskFunctionName(name): void
+
+
Parameters
+
- +
  name: string
Returns void
- Defined in src/worker/abstract-worker.ts:146

`Private` checkFunctionInput

checkFunctionInput(fn: ((data: Data) => Response)): void
Defined in src/worker/abstract-worker.ts:308

`Private` checkTaskFunctions

checkTaskFunctions(taskFunctions): void
-
Checks if the fn parameter is passed to the constructor.
+
Checks if the taskFunctions parameter is passed to the constructor.
Parameters
- -
  fn: ((data: Data) => Response)
  -
  The function that should be defined.
  +
  taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
  +
  The task function(s) parameter that should be checked.
  
  -
  -
  -
  -
  (data: Data): Response
  +
  +
  Returns void
  +
  +
  +
  Defined in src/worker/abstract-worker.ts:132

`Private` checkValidTaskFunction

checkValidTaskFunction(name, fn): void
Parameters
- -
  data: Data
-
Returns Response

name: string

fn: TaskFunction<Data, Response>

Returns void

`Private` checkWorkerOptions

checkWorkerOptions(opts: WorkerOptions): void
Defined in src/worker/abstract-worker.ts:106

`Private` checkWorkerOptions

checkWorkerOptions(opts): void
Parameters
- -
  opts: WorkerOptions
+
opts: WorkerOptions

Returns void

emitDestroy

emitDestroy(): AbstractWorker<MainWorker, Data, Response>
Defined in src/worker/abstract-worker.ts:101

emitDestroy

emitDestroy(): AbstractWorker<MainWorker, Data, Response>
Call all destroy hooks. This should only ever be called once. An error will be thrown if it is called more than once. This must be manually called. If the resource is left to be collected by the GC then the destroy hooks will never be called.
- -
Returns
A reference to asyncResource.

-
Returns AbstractWorker<MainWorker, Data, Response>
+
Returns AbstractWorker<MainWorker, Data, Response>
A reference to asyncResource.
+ +
Inherited from AsyncResource.emitDestroy
- Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:311

`Protected` getMainWorker

getMainWorker(): MainWorker
Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/async_hooks.d.ts:302

`Private` endTaskPerformance

endTaskPerformance(taskPerformance): TaskPerformance
+
+
Parameters
+
- +
  taskPerformance: TaskPerformance
+
Returns TaskPerformance
+
- Defined in src/worker/abstract-worker.ts:585

`Protected` getMainWorker

getMainWorker(): MainWorker
Returns the main worker.
- -
Returns
Reference to the main worker.

-
Returns MainWorker
+
Returns MainWorker
Reference to the main worker.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-error If the main worker is not set.
+
- Defined in src/worker/abstract-worker.ts:129

`Protected` handleError

handleError(e: string | Error): string
Defined in src/worker/abstract-worker.ts:434

`Protected` handleError

handleError(e): string
Handles an error and convert it to a string so it can be sent back to the main worker.
- -
Returns
Message of the error.
Parameters
- -
  e: string | Error
  +
  e: string | Error
  
  The error raised by the worker.
  -
-
Returns string
+ +

Returns string

The error message.

+ +

`Protected` messageListener

messageListener(message: MessageValue<Data, MainWorker>, fn: ((data: Data) => Response)): void
Defined in src/worker/abstract-worker.ts:466

`Protected` handleKillMessage

handleKillMessage(message): void
-
Worker message listener.
+
Handles a kill message sent by the main worker.
Parameters
- -
  message: MessageValue<Data, MainWorker>
  -
  Message received.
  -
- -
  fn: ((data: Data) => Response)
  -
  Function processed by the worker when the pool's execution function is invoked.
  +
  message: MessageValue<Data, unknown>
  +
  The kill message.
  
  -
  -
  -
  -
  (data: Data): Response
  +
  +
  Returns void
  +
  +
  +
  Defined in src/worker/abstract-worker.ts:351

`Protected` `Abstract` handleReadyMessage

handleReadyMessage(message): void
+
Handles the ready message sent by the main worker.
+
Parameters
- -
  data: Data
-
Returns Response

Returns void

`Protected` run

run(fn: ((data?: Data) => Response), message: MessageValue<Data, unknown>): void
Defined in src/worker/abstract-worker.ts:322

hasTaskFunction

hasTaskFunction(name): boolean
-
Runs the given function synchronously.
+
Checks if the worker has a task function with the given name.
Parameters
- -
  fn: ((data?: Data) => Response)
  -
  Function that will be executed.
  +
  name: string
  +
  The name of the task function to check.
  
  -
  -
  -
  -
  (data?: Data): Response
  +
  +
  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 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.
+ +
+
- Defined in src/worker/abstract-worker.ts:255

`Protected` messageListener

messageListener(message): void
+
Worker message listener.
+
Parameters
- -
  Optional data: Data
-
Returns Response

message: MessageValue<Data, unknown>

The received message.

Returns void

removeTaskFunction

removeTaskFunction(name): boolean
+
Removes a task function from the worker.
+
+
+
Parameters
+
- -
  message: MessageValue<Data, unknown>
  -
  Input data for the given function.
  -
-
Returns void
+
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 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.

`Protected` runAsync

runAsync(fn: ((data?: Data) => Promise<Response>), message: MessageValue<Data, unknown>): void
Defined in src/worker/abstract-worker.ts:231

`Protected` run

run(task): void
-
Runs the given function asynchronously.
+
Runs the given task.
Parameters
- -
  fn: ((data?: Data) => Promise<Response>)
  -
  Function that will be executed.
  +
  task: Task<Data>
  +
  The task to execute.
  
  -
  -
  -
  -
  (data?: Data): Promise<Response>
  +
  +
  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 task function asynchronously.
+
Parameters
- -
  Optional data: Data
-
Returns Promise<Response>

fn: TaskAsyncFunction<Data, Response>

Task function that will be executed.

message: MessageValue<Data, unknown>

Input data for the given function.

Returns void

runInAsyncScope

runInAsyncScope<This, Result>(fn: ((this: This, ...args: any[]) => Result), thisArg?: This, ...args: any[]): Result
Defined in src/worker/abstract-worker.ts:541

runInAsyncScope

runInAsyncScope<This, Result>(fn, thisArg?, ...args): Result
Call the provided function with the provided arguments in the execution context of the async resource. This will establish the context, trigger the AsyncHooks before callbacks, call the function, trigger the AsyncHooks after callbacks, and then restore the original execution context.
- -
Since
v9.6.0

-
+
Type Parameters
-
+
Result

Parameters

-
fn: ((this: This, ...args: any[]) => Result)
+
fn: ((this, ...args) => Result)

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

+
- -
  - (this: This, ...args: any[]): Result

Returns Result

`Optional` thisArg: This

The receiver to be used for the function call.

+ +

`Rest` ...args: any[]

Optional arguments to pass to the function.

Returns Result

`Protected` runSync

runSync(fn, task): void
-
Sends a message to the main worker.
+
Runs the given task function synchronously.
Parameters
- -
  message: MessageValue<Response, unknown>
  +
  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
+
+
- Defined in src/worker/abstract-worker.ts:453

`Protected` `Abstract` sendToMainWorker

sendToMainWorker(message): void
+
Sends a message to main worker.
+
+
+
Parameters
+
- +
  message: MessageValue<Response, Data>
  
  The response message.
  -
-
Returns void
+ +

Returns void

triggerAsyncId

triggerAsyncId(): number
Defined in src/worker/abstract-worker.ts:446

setDefaultTaskFunction

setDefaultTaskFunction(name): boolean
+
Sets the default task function to use in the worker.
+
+
+
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.
+
-
Returns
The same triggerAsyncId that is passed to the AsyncResource constructor.
+
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:285

`Private` startCheckActive

startCheckActive(): void
+
Starts the worker check active interval.
+
+
Returns void
+
+
- Defined in src/worker/abstract-worker.ts:398

`Private` stopCheckActive

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

-
Returns number
+
Returns void
+
+
- Defined in src/worker/abstract-worker.ts:409

triggerAsyncId

triggerAsyncId(): number
+
Returns number
The same triggerAsyncId that is passed to the AsyncResource constructor.
+ +
Inherited from AsyncResource.triggerAsyncId
- Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:320

`Static` bind

bind<Func, ThisArg>(fn: Func, type?: string, thisArg?: ThisArg): Func & {
Â Â Â Â asyncResource: AsyncResource;
}
Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/async_hooks.d.ts:311

`Private` updateLastTaskTimestamp

updateLastTaskTimestamp(): void
+
Returns void
+
- Defined in src/worker/abstract-worker.ts:606

`Static` bind

bind<Func, ThisArg>(fn, type?, thisArg?): Func
Binds the given function to the current execution context.
-
The returned function will have an asyncResource property referencing -the AsyncResource to which the function is bound.
- -
Since
v14.8.0, v12.19.0

-
+
Type Parameters
-
+
ThisArg