ThreadWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FThreadWorker.html;h=3fcf96a7f322699507cb4f27b3eedb00ed8b4421;hb=95d287d1625c80929657a9f217774c5c8f6668e7;hp=d432e78534adfbf6482a685f243b588ba35a1507;hpb=69f8ce0ab8ce1afcf350b21796496b8dcd2aaec1;p=poolifier.git diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index d432e785..7dcea1ef 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,4 +1,4 @@ -ThreadWorker | poolifier

+ThreadWorker | poolifier - v2.6.41

Author

Alessandro Pio Ardizio

Author

Alessandro Pio Ardizio

- -

Since

0.0.1

Since

0.0.1

Type Parameters

-
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 thread. This can only be serializable data.
-

Response = unknown

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

Hierarchy

AbstractWorker<MessagePort, Data, Response> +
AbstractWorker<MessagePort, Data, Response>
- ThreadWorker

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

@@ -52,417 +55,621 @@ but the minimum number of workers will be guaranteed.

Constructors

constructor +

constructor

Properties

aliveInterval? -lastTaskTimestamp -mainWorker -opts +

activeInterval? +isMain +lastTaskTimestamp +opts +port +statistics +taskFunctions +

Accessors

Constructors

constructor

new ThreadWorker<Data, Response>(fn: ((data: Data) => Response), opts?: WorkerOptions): ThreadWorker<Data, Response>

constructor

new ThreadWorker<Data, Response>(taskFunctions, opts?): ThreadWorker<Data, Response>
Constructs a new poolifier thread worker.

-
+
Type Parameters
-
+
Response = unknown

Parameters

-
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

taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>

Task function(s) processed by the worker when the pool's execution function is invoked.

-
opts: WorkerOptions = {}
+
opts: WorkerOptions = {}

Options for the worker.

Returns ThreadWorker<Data, Response>

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

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

Timestamp of the last task processed by this worker.

`Protected` mainWorker

mainWorker: undefined | null | MessagePort

`Readonly` opts

opts: WorkerOptions

`Protected` opts

opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

Options for the worker.

`Private` port

port: MessagePort

Message port used to communicate with the main worker.

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

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

Accessors

`Protected` id

get id(): number
+
Worker id.
+
+
Returns number
+
+
Overrides AbstractWorker.id
+
- Defined in src/worker/thread-worker.ts:86

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
-
Inherited from AbstractWorker.asyncId
+
+
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.
+
+
Inherited from AbstractWorker.addTaskFunction
- Defined in node_modules/@types/node/ts4.8/async_hooks.d.ts:315

bind

bind<Func>(fn: Func): Func & {
Â Â Â Â asyncResource: AsyncResource;
}
Defined in src/worker/abstract-worker.ts:193

asyncId

asyncId(): number
-
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.
+
Returns number
The unique asyncId assigned to the resource.
-
Since
v14.8.0, v12.19.0
+
+
Inherited from AbstractWorker.asyncId
+
- Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/async_hooks.d.ts:306

bind

bind<Func>(fn): Func
+
Binds the given function to execute to this AsyncResource's scope.

-
+
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
-
Checks if the worker should be terminated, because its living too long.
-
-
Returns void
-
Inherited from AbstractWorker.checkAlive
+
Returns Func
+
+
Since
v14.8.0, v12.19.0
+
+
Inherited from AbstractWorker.bind
- Defined in src/worker/abstract-worker.ts:141

emitDestroy

emitDestroy(): ThreadWorker<Data, Response>
Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/async_hooks.d.ts:283

emitDestroy

emitDestroy(): ThreadWorker<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 ThreadWorker<Data, Response>
-
Inherited from AbstractWorker.emitDestroy
+
Returns ThreadWorker<Data, Response>
A reference to asyncResource.
+ +
+
Inherited from AbstractWorker.emitDestroy
- Defined in node_modules/@types/node/ts4.8/async_hooks.d.ts:311

`Protected` getMainWorker

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

`Protected` getMainWorker

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

-
Returns MessagePort
-
Inherited from AbstractWorker.getMainWorker
+
Returns MessagePort
Reference to the main worker.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-error If the main worker is not set.
+
+
Inherited from AbstractWorker.getMainWorker
- Defined in src/worker/abstract-worker.ts:124

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

`Protected` messageListener

messageListener(value: MessageValue<Data, MessagePort>, fn: ((data: Data) => Response)): void

Returns string

The error message.

`Protected` handleKillMessage

handleKillMessage(message): void
+
Handles a kill message sent by the main worker.
+
Parameters
- -
  value: MessageValue<Data, MessagePort>
- -
  fn: ((data: Data) => Response)
  -
  - -
    - (data: Data): Response
+
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
- -
  data: Data
-
Returns Response

Returns void

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

listTaskFunctions

listTaskFunctions(): string[]
+
Lists the names of the worker's task functions.

-
- -
  - (data?: Data): Response

`Protected` messageListener

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

value: MessageValue<Data, unknown>

Input data for the given function.

message: MessageValue<Data, unknown>

The received message.

Returns void

`Protected` runAsync

runAsync(fn: ((data?: Data) => Promise<Response>), value: MessageValue<Data, unknown>): void

Returns void

removeTaskFunction

removeTaskFunction(name): boolean
-
Runs the given function asynchronously.
+
Removes a task function from the worker.
Parameters
- -
  fn: ((data?: Data) => Promise<Response>)
  -
  Function that will be executed.
  +
  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.
+
+
Inherited from AbstractWorker.removeTaskFunction
+
- Defined in src/worker/abstract-worker.ts:231

`Protected` run

run(task): void
+
Runs the given task.

-
- -
  - (data?: Data): Promise<Response>

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

value: MessageValue<Data, unknown>

Input data for the given function.

task: Task<Data>

Input data for the task function.

Returns void

runInAsyncScope

runInAsyncScope<This, Result>(fn: ((this: This, ...args: any[]) => Result), thisArg?: This, ...args: any[]): Result

Returns void

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.

+Optional

`Rest` ...args: any[]

Optional arguments to pass to the function.

Rest

Returns Result

Since

v9.6.0

`Protected` runSync

runSync(fn, task): void
+
Runs the given task function synchronously.
+
+
+
Parameters
+
- +
  fn: TaskSyncFunction<Data, Response>
  +
  Task function that will be executed.
  +
- +
  task: Task<Data>
  +
  Input data for the task function.
-
Returns Result
-
Inherited from AbstractWorker.runInAsyncScope
-
- Defined in node_modules/@types/node/ts4.8/async_hooks.d.ts:303

`Protected` sendToMainWorker

sendToMainWorker(message: MessageValue<Response, unknown>): void

Returns void

`Protected` sendTaskFunctionsListToMainWorker

sendTaskFunctionsListToMainWorker(): void
-
-
Inherit Doc
+
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 main worker.
+
Parameters
- -
  message: MessageValue<Response, unknown>
-
Returns void
-
Overrides AbstractWorker.sendToMainWorker
+
message: MessageValue<Response, unknown>
+
The response message.
+

Returns void

triggerAsyncId

triggerAsyncId(): number
Defined in src/worker/thread-worker.ts:91

setDefaultTaskFunction

setDefaultTaskFunction(name): boolean
-
-
Returns
The same triggerAsyncId that is passed to the AsyncResource constructor.
+
Sets the default task function to use in the worker.

-
Returns number
-
Inherited from AbstractWorker.triggerAsyncId
+
+
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 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.
+
+
Inherited from AbstractWorker.setDefaultTaskFunction
- Defined in node_modules/@types/node/ts4.8/async_hooks.d.ts:320

`Static` bind

bind<Func, ThisArg>(fn: Func, type?: string, thisArg?: ThisArg): Func & {
Â Â Â Â asyncResource: AsyncResource;
}
Defined in src/worker/abstract-worker.ts:285

triggerAsyncId

triggerAsyncId(): number
-
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.
+
Returns number
The same triggerAsyncId that is passed to the AsyncResource constructor.
-
Since
v14.8.0, v12.19.0
+
+
Inherited from AbstractWorker.triggerAsyncId
+
- Defined in node_modules/.pnpm/@types+node@20.5.9/node_modules/@types/node/async_hooks.d.ts:311

`Static` bind

bind<Func, ThisArg>(fn, type?, thisArg?): Func
+
Binds the given function to the current execution context.

-
+
Type Parameters
-
+
ThisArg

Parameters

-
fn: Func
+
fn: Func

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

An optional name to associate with the underlying AsyncResource.
-