ClusterWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FClusterWorker.html;h=b49441155dbec0d86c16b63623259454917d0a35;hb=6d6c7ed0c2c3c83cefae4d8cd5bc9393126bba70;hp=07db2b16cdbeacc1deae33360581b27427fb3668;hpb=21402562176f7550bcd9ba620cf551972fca6e98;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 07db2b16..b4944115 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -ClusterWorker | poolifier

+ClusterWorker | poolifier

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,283 +55,259 @@ but the minimum number of workers will be guaranteed.

Constructors

constructor +

constructor

Properties

aliveInterval? -isMain -lastTaskTimestamp -mainWorker -opts +

aliveInterval? +isMain +lastTaskTimestamp +mainWorker +opts +statistics +taskFunctions

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

`Protected` `Optional` `Readonly` aliveInterval

aliveInterval?: Timeout

Handler id of the aliveInterval worker alive check.

`Protected` `Readonly` isMain

isMain: boolean

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

`Protected` `Readonly` isMain

isMain: boolean

Whether this is the main worker or not.

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

Timestamp of the last task processed by this worker.

`Protected` mainWorker

mainWorker: undefined | null | Worker

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

`Protected` `Readonly` mainWorker

mainWorker: Worker

Reference to main worker.

`Protected` `Readonly` opts

opts: WorkerOptions = ...

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

`Protected` `Readonly` opts

opts: WorkerOptions = ...

Options for the worker.

`Protected` statistics

statistics: WorkerStatistics

Performance statistics computation requirements.

`Protected` taskFunctions

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

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

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

Methods

asyncId

asyncId(): number

asyncId

asyncId(): number
-
-
Returns
The unique asyncId assigned to the resource.
-
-
Returns number
-
Inherited from AbstractWorker.asyncId
+
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.3.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
Defined in node_modules/.pnpm/@types+node@20.3.3/node_modules/@types/node/async_hooks.d.ts:283

`Protected` checkAlive

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

-
Returns void
-
Inherited from AbstractWorker.checkAlive
+
Returns void
+
+
Inherited from AbstractWorker.checkAlive
- Defined in src/worker/abstract-worker.ts:146

emitDestroy

emitDestroy(): ClusterWorker<Data, Response>
Defined in src/worker/abstract-worker.ts:192

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>
-
Inherited from AbstractWorker.emitDestroy
+
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.3.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
-
Inherited from AbstractWorker.getMainWorker
-
- Defined in src/worker/abstract-worker.ts:129

`Protected` handleError

handleError(e: string | Error): string
-
-
Inherit Doc
-
-
Parameters
-
- -
  e: string | Error
-
Returns string
-
Overrides AbstractWorker.handleError
+
Returns Worker
Reference to the main worker.
+ +
+
Inherited from AbstractWorker.getMainWorker
- Defined in src/worker/cluster-worker.ts:47

`Protected` messageListener

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

`Protected` handleError

handleError(e): string
-
Worker message listener.
+
Handles an error and convert it to a string so it can be sent back to 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.
  +
  e: string | Error
  +
  The error raised by the worker.
  
  -
  -
  -
  -
  (data: Data): Response
  -
  -
  -
  Parameters
  -
  -
  -
  data: Data
  -
  Returns Response
-
Returns void
-
Inherited from AbstractWorker.messageListener
+

Returns string

The error message.

+ +

`Protected` run

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

`Protected` messageListener

messageListener(message): void
-
Runs the given function synchronously.
+
Worker message listener.
Parameters
- -
  fn: ((data?: Data) => Response)
  -
  Function that will be executed.
  +
  message: MessageValue<Data, Data>
  +
  Message received.
  
  -
  -
  -
  -
  (data?: Data): Response
  -
  -
  -
  Parameters
  -
  -
  -
  Optional data: Data
  -
  Returns Response
- -
  message: MessageValue<Data, unknown>
  -
  Input data for the given function.
  -
-
Returns void
-
Inherited from AbstractWorker.run
+

Returns void

`Protected` runAsync

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

`Protected` runAsync

runAsync(fn, message): void
Runs the given function asynchronously.

@@ -336,146 +315,172 @@ never be called.

Parameters
- -
  fn: ((data?: Data) => Promise<Response>)
  +
  fn: WorkerAsyncFunction<Data, Response>
  
  Function that will be executed.
  
  -
  - -
    - (data?: Data): Promise<Response>
    - -
      -
      Parameters
      -
      -
      -
      Optional data: Data
      -
      Returns Promise<Response>
- -
  message: MessageValue<Data, unknown>
  +
  message: MessageValue<Data, unknown>
  
  Input data for the given function.
  -
-
Returns void
-
Inherited from AbstractWorker.runAsync
+ +

Returns void

runInAsyncScope

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

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, message): void
-
-
Inherit Doc
+
Runs the given function synchronously.
+
Parameters
- -
  message: MessageValue<Response, unknown>
-
Returns void
-
Overrides AbstractWorker.sendToMainWorker
+
fn: WorkerSyncFunction<Data, Response>
+
Function that will be executed.
+
+
+
message: MessageValue<Data, unknown>
+
Input data for the given function.
+
+

Returns void

triggerAsyncId

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

`Protected` sendToMainWorker

sendToMainWorker(message): void
-
-
Returns
The same triggerAsyncId that is passed to the AsyncResource constructor.
+
Sends a message to the main worker.
+
+
+
Parameters
+
- +
  message: MessageValue<Response, unknown>
  +
  The response message.
  
  -
  Returns number
  -
  Inherited from AbstractWorker.triggerAsyncId
  +
+
Returns void
+
+
Overrides AbstractWorker.sendToMainWorker
- 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 src/worker/cluster-worker.ts:47

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.3.3/node_modules/@types/node/async_hooks.d.ts:311