ClusterWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FClusterWorker.html;h=8dea95ee7683cb407a4b51654609ed78464f414a;hb=15e4d8f3cafe9f7412913b0e440921e813bdf3cd;hp=3a362686df908df9bf367a28bcc161536cff5524;hpb=ab03ecdd9c195574f19dbed3b36641229c24f723;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 3a362686..8dea95ee 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -ClusterWorker | poolifier

+ClusterWorker | poolifier

@@ -30,21 +30,21 @@ but the minimum number of workers will be guaranteed.

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

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

Constructors

constructor +

constructor

Properties

aliveInterval? -isMain -lastTaskTimestamp -mainWorker -opts +

aliveInterval? +isMain +lastTaskTimestamp +mainWorker +opts

Constructors

constructor

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

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

@@ -91,72 +91,72 @@ but the minimum number of workers will be guaranteed.

Type Parameters
- -
  Data = unknown
- -
  Response = unknown

Response = unknown

Parameters

-
fn: WorkerFunction<Data, Response>
+
fn: WorkerFunction<Data, Response>

Function 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:31

Properties

`Protected` `Optional` `Readonly` aliveInterval

aliveInterval?: Timeout

Handler id of the aliveInterval worker alive check.

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

`Protected` `Readonly` isMain

isMain: boolean

Whether this is the main worker or not.

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

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

Timestamp of the last task processed by this worker.

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

`Protected` mainWorker

mainWorker: undefined | null | Worker

Reference to main worker.

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

`Protected` `Readonly` opts

opts: WorkerOptions = ...

Options for the worker.

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

Methods

asyncId

asyncId(): number

asyncId(): number
Returns
The unique asyncId assigned to the resource.
@@ -165,10 +165,10 @@ but the minimum number of workers will be guaranteed.

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

bind<Func>(fn): Func & {
Â Â Â Â asyncResource: AsyncResource;
}
Binds the given function to execute to this AsyncResource's scope.

The returned function will have an asyncResource property referencing @@ -180,33 +180,33 @@ the AsyncResource to which the function is bound.

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

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

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

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

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 @@ -215,27 +215,27 @@ never be called.

Returns
A reference to asyncResource.

-
Returns ClusterWorker<Data, Response>
+
Returns ClusterWorker<Data, Response>
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

getMainWorker(): Worker
Returns the main worker.

Returns
Reference to the main worker.

-
Returns Worker
+
Returns Worker
Inherited from AbstractWorker.getMainWorker
- Defined in src/worker/abstract-worker.ts:139

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

`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.
@@ -245,17 +245,17 @@ never be called.

Parameters
- -
  e: string | Error
  +
  e: string | Error
  
  The error raised by the worker.
Returns string
Overrides AbstractWorker.handleError
- Defined in src/worker/cluster-worker.ts:50

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

`Protected` messageListener

messageListener(message: MessageValue<Data, Worker>, fn: WorkerFunction<Data, Response>): void

messageListener(message, fn): void
Worker message listener.

@@ -263,21 +263,21 @@ never be called.

Parameters
- -
  message: MessageValue<Data, Worker>
  +
  message: MessageValue<Data, Worker>
  
  Message received.
- -
  fn: WorkerFunction<Data, Response>
  +
  fn: WorkerFunction<Data, Response>
  
  Function processed by the worker when the pool's execution function is invoked.

Returns void

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

`Protected` run

run(fn: WorkerSyncFunction<Data, Response>, message: MessageValue<Data, unknown>): void

run(fn, message): void
Runs the given function synchronously.

@@ -285,21 +285,21 @@ never be called.

Parameters
- -
  fn: WorkerSyncFunction<Data, Response>
  +
  fn: WorkerSyncFunction<Data, Response>
  
  Function that will be executed.
- -
  message: MessageValue<Data, unknown>
  +
  message: MessageValue<Data, unknown>
  
  Input data for the given function.

Returns void

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

`Protected` runAsync

runAsync(fn: WorkerAsyncFunction<Data, Response>, message: MessageValue<Data, unknown>): void

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

@@ -307,21 +307,21 @@ never be called.

Parameters
- -
  fn: WorkerAsyncFunction<Data, Response>
  +
  fn: WorkerAsyncFunction<Data, Response>
  
  Function that will be executed.
- -
  message: MessageValue<Data, unknown>
  +
  message: MessageValue<Data, unknown>
  
  Input data for the given function.
Returns void
Inherited from AbstractWorker.runAsync
- Defined in src/worker/abstract-worker.ts:208

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

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 @@ -334,45 +334,45 @@ then restore the original execution context.

Type Parameters
- -
  This
- -
  Result

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

triggerAsyncId

triggerAsyncId(): number

triggerAsyncId(): number
Returns
The same triggerAsyncId that is passed to the AsyncResource constructor.
@@ -399,10 +399,10 @@ then restore the original execution context.

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

bind<Func, ThisArg>(fn, type?, thisArg?): Func & {
Â Â Â Â asyncResource: AsyncResource;
}
Binds the given function to the current execution context.

The returned function will have an asyncResource property referencing @@ -414,23 +414,23 @@ the AsyncResource to which the function is bound.

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

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

`Optional` thisArg: ThisArg

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

@@ -448,74 +448,74 @@ the AsyncResource to which the function is bound.

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

Returns

Type Parameters

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

Returns void

Returns

Returns ClusterWorker<Data, Response>

Returns

Returns Worker

Parameters

e: string | Error

e: string | Error

Returns string

Parameters

message: MessageValue<Data, Worker>

message: MessageValue<Data, Worker>

fn: WorkerFunction<Data, Response>

fn: WorkerFunction<Data, Response>

Parameters

this: This

this: This

Rest ...args: any[]

Returns Result

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

ThisArg

`Rest` ...args: any[]