ClusterWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FClusterWorker.html;h=b28355977ded6eeb9de3c98eb45246d7a74eb4e0;hb=70353024c44987c467dadcec306c699ce4ae1f06;hp=4476d945541582990753b0308c10eb69adf28196;hpb=a1e5b51ea192bdcad4751d1f4facc19498ee4f1d;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 4476d945..b2835597 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -ClusterWorker | poolifier

+ClusterWorker | poolifier

@@ -26,25 +26,25 @@ but the minimum number of workers will be guaranteed.

Since

2.0.0

Type Parameters

-
Data = unknown
+
Data = unknown

Type of data this worker receives from pool's execution. This can only be serializable data.
-
Response = unknown
+
Response = unknown

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

Hierarchy

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

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

@@ -52,221 +52,213 @@ but the minimum number of workers will be guaranteed.

Constructors

constructor +

constructor

Properties

aliveInterval? -isMain -lastTaskTimestamp -mainWorker -opts +

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

Constructors

constructor

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

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

-
+
Type Parameters
-
+
Response = unknown

Parameters

-
fn: ((data: Data) => Response | Promise<Response>)
-
Function processed by the worker when the pool's execution function is invoked.
-
-
- -
  - (data: Data): Response | Promise<Response>
  - -
    -
    Parameters
    -
    - -
      data: Data
    -
    Returns Response | Promise<Response>

taskFunctions: WorkerFunction<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 ClusterWorker<Data, Response>

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

Properties

`Protected` `Optional` `Readonly` aliveInterval

aliveInterval?: Timeout

Handler id of the aliveInterval worker alive check.

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

`Protected` `Readonly` isMain

isMain: boolean

Whether this is the main worker or not.

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

Timestamp of the last task processed by this worker.

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

`Protected` mainWorker

mainWorker: undefined | null | Worker

Reference to main worker.

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

`Protected` `Readonly` opts

opts: WorkerOptions = ...

Options for the worker.

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

`Protected` taskFunctions

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

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

Methods

asyncId

asyncId(): number

asyncId(): number
-
-
Returns
The unique asyncId assigned to the resource.
-
-
Returns 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

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

bind

bind<Func>(fn: Func): Func & {
Â Â Â Â asyncResource: AsyncResource;
}

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

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

`Protected` checkAlive

checkAlive(): void

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

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

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

emitDestroy

emitDestroy(): ClusterWorker<Data, Response>

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

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

`Protected` getMainWorker

getMainWorker(): Worker

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

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

`Protected` handleError

handleError(e: string | Error): string

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
Message of the error.
+
Overrides AbstractWorker.handleError
- Defined in src/worker/cluster-worker.ts:50

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

`Protected` messageListener

messageListener(message: MessageValue<Data, Worker>, fn: ((data: Data) => Response | Promise<Response>)): void

messageListener(message): void
Worker message listener.

@@ -274,65 +266,17 @@ never be called.

Parameters
- -
  message: MessageValue<Data, Worker>
  +
  message: MessageValue<Data, Worker>
  
  Message received.
  -
- -
  fn: ((data: Data) => Response | Promise<Response>)
  -
  Function processed by the worker when the pool's execution function is invoked.
  -
  -
  - -
    - (data: Data): Response | Promise<Response>
    - -
      -
      Parameters
      -
      -
      -
      data: Data
      -
      Returns Response | Promise<Response>

Returns void

`Protected` run

run(fn: ((data?: Data) => Response), message: MessageValue<Data, unknown>): void
-
Runs the given function synchronously.
-
-
-
Parameters
-
- -
  fn: ((data?: Data) => Response)
  -
  Function that will be executed.
  -
  -
  - -
    - (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
+
Inherited from AbstractWorker.messageListener
- Defined in src/worker/abstract-worker.ts:178

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

`Protected` runAsync

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

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

@@ -340,32 +284,21 @@ 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, Worker | MessagePort>
  
  Input data for the given function.
Returns void
Inherited from AbstractWorker.runAsync
- Defined in src/worker/abstract-worker.ts:205

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

runInAsyncScope

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

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 @@ -374,49 +307,71 @@ 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
+
Runs the given function synchronously.
+
+
+
Parameters
+
- +
  fn: WorkerSyncFunction<Data, Response>
  +
  Function that will be executed.
  +
- +
  message: MessageValue<Data, Worker | MessagePort>
  +
  Input data for the given function.
  +
+
Returns void
+
Inherited from AbstractWorker.runSync
+
- Defined in src/worker/abstract-worker.ts:204

`Protected` sendToMainWorker

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

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

@@ -424,60 +379,57 @@ then restore the original execution context.

Parameters
- -
  message: MessageValue<Response, unknown>
  +
  message: MessageValue<Response, Worker | MessagePort>
  
  The response message.
Returns void
Overrides AbstractWorker.sendToMainWorker
- Defined in src/worker/cluster-worker.ts:45

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

triggerAsyncId

triggerAsyncId(): number

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

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

`Static` bind

bind<Func, ThisArg>(fn: Func, type?: string, thisArg?: ThisArg): Func & {
Â Â Â Â asyncResource: AsyncResource;
}

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

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.
-
Optional thisArg: ThisArg

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

Theme

WorkerChoiceStrategyContext

ClusterPoolOptions

IPool

IWorker

IWorkerChoiceStrategy

MessageValue

PoolOptions

PromiseResponseWrapper

WorkerChoiceStrategyOptions

ThreadWorkerWithMessageChannel

WorkerChoiceStrategies

Generated using TypeDoc

\ No newline at end of file

Constructors

Properties

Methods

Type Parameters

Data = unknown

Data = unknown

Response = unknown

Response = unknown

Parameters

data: Data

Returns Response | Promise<Response>

Returns

Since

Type Parameters

Func extends ((...args: any[]) => any)

Func extends ((...args) => any)

e: string | Error

e: string | Error

message: MessageValue<Data, Worker>

message: MessageValue<Data, Worker>

fn: ((data: Data) => Response | Promise<Response>)

Parameters

data: Data

Returns Response | Promise<Response>

Parameters

Optional data: Data

Returns Response

Parameters

Optional data: Data

Returns Promise<Response>

This

This

Result

Parameters

this: This

this: This

Rest ...args: any[]

Returns Result

Func extends ((this: ThisArg, ...args: any[]) => any)

Func extends ((this, ...args) => any)

ThisArg

`Optional` data: Data

`Optional` data: Data

`Rest` ...args: any[]