ClusterWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FClusterWorker.html;h=8e355dd5cc732c4e3f3f551e4298b7984b3d947f;hb=31542ddfe8297d3bd0f9cf97a3de06a03dafc15d;hp=a9b4c167b98b07aefca7eb0714391afe847fb439;hpb=842d8918a19fc2720d4436789a2e373bc623452e;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index a9b4c167..e088cd1b 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -ClusterWorker | poolifier

+ClusterWorker | poolifier - v2.6.32

@@ -21,30 +21,33 @@ it will send a termination request to its main worker.

If you use a DynamicClusterPool the extra workers that were created will be terminated, but the minimum number of workers will be guaranteed.

Author

Christopher Quadflieg

Author

Christopher Quadflieg

- -

Since

2.0.0

Since

2.0.0

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

AbstractWorker<Worker, Data, Response> +
AbstractWorker<Worker, Data, Response>
- ClusterWorker

Defined in src/worker/cluster-worker.ts:21

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

Constructors

constructor +

constructor

Properties

aliveInterval? -isMain -lastTaskTimestamp -mainWorker -opts +

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

Accessors

Constructors

constructor

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

constructor

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

-
+
Type Parameters
-
+
Response = unknown

Parameters

-
fn: ((data: Data) => Response)
-
Function processed by the worker when the pool's execution function is invoked.
+
taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
+
Task function(s) processed by the worker when the pool's execution function is invoked.

-
- -
  - (data: Data): Response
  - -
    -
    Parameters
    -
    +
    
    -
    data: Data
    -
    Returns Response
-
opts: WorkerOptions = {}
+
opts: WorkerOptions = {}

Options for the worker.
-

Returns ClusterWorker<Data, Response>

Defined in src/worker/cluster-worker.ts:31

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

Reference to main worker.

`Protected` `Readonly` opts

opts: WorkerOptions = ...

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

`Protected` opts

opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

Options for the worker.

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

`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/cluster-worker.ts:65

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

asyncId

asyncId(): number
+
Returns number
The unique asyncId assigned to the resource.
+ +
Inherited from AbstractWorker.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.3/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.
-
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
-
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

emitDestroy

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

emitDestroy

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

`Protected` getMainWorker

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

`Protected` getMainWorker

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

-
Returns Worker
+
Returns Worker
Reference to the main worker.
+ +
Inherited from AbstractWorker.getMainWorker
- Defined in src/worker/abstract-worker.ts:129

`Protected` handleError

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

`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
-
Overrides AbstractWorker.handleError
+ +

Returns string

The error message.

+ +

`Protected` messageListener

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

`Protected` handleKillMessage

handleKillMessage(message): void
-
Worker message listener.
+
Handles a kill message sent by the main worker.
Parameters
- -
  message: MessageValue<Data, Worker>
  -
  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
  +
  +
  Inherited from AbstractWorker.handleKillMessage
  +
  +
  Defined in src/worker/abstract-worker.ts:341

`Protected` 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/cluster-worker.ts:45

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

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

`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
-
Inherited from AbstractWorker.run
+
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:221

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

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

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

`Protected` sendTaskFunctionsListToMainWorker

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

`Protected` sendToMainWorker

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

Returns void

triggerAsyncId

triggerAsyncId(): number
Defined in src/worker/cluster-worker.ts:70

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
+
+
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 src/worker/abstract-worker.ts:275

triggerAsyncId

triggerAsyncId(): number
+
Returns number
The same triggerAsyncId that is passed to the AsyncResource constructor.
+ +
Inherited from AbstractWorker.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.3/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.
-
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