ClusterWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FClusterWorker.html;h=25a0631288d236f9aa85eecbfbeaef8bb4827e61;hb=13aa72e5091fcfe52dcd2acf1039091e1d55ea32;hp=cdfaa2f052ff269ba061e2fe0a3f00758a8f78f0;hpb=67ff85c0f9bf4f18372728327fc5373f17d9e13a;p=poolifier.git diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index cdfaa2f0..25a06312 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -ClusterWorker | poolifier

+ClusterWorker | poolifier

@@ -57,9 +57,10 @@ but the minimum number of workers will be guaranteed.

Properties

aliveInterval? +isMain lastTaskTimestamp mainWorker -opts +opts

Methods

@@ -82,7 +83,7 @@ but the minimum number of workers will be guaranteed.

constructor

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

@@ -97,62 +98,59 @@ but the minimum number of workers will be guaranteed.

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

opts: WorkerOptions = {}

Options for the worker.

Returns ClusterWorker<Data, Response>

Properties

`Protected` `Optional` `Readonly` aliveInterval

aliveInterval?: Timeout

Handler Id of the aliveInterval worker alive check.

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.

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

`Readonly` opts

opts: WorkerOptions

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

@@ -164,13 +162,13 @@ but the minimum number of workers will be guaranteed.

Returns

The unique asyncId assigned to the resource.

Returns number

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): Func & {
Â Â Â Â asyncResource: AsyncResource;
}
Binds the given function to execute to this AsyncResource's scope.

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

Parameters
- -
  fn: Func
  +
  fn: Func
  
  The function to bind to the current AsyncResource.
-
Returns Func & {
Â Â Â Â asyncResource: AsyncResource;
}
-
Inherited from AbstractWorker.bind
+
Returns Func & {
Â Â Â Â asyncResource: AsyncResource;
}
+
Inherited from AbstractWorker.bind
- Defined in node_modules/@types/node/async_hooks.d.ts:288

Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:288

`Protected` checkAlive

AsyncResource

Checks if the worker should be terminated, because its living too long.

Returns void

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

Returns
A reference to asyncResource.

-
Returns ClusterWorker<Data, Response>
-
Inherited from AbstractWorker.emitDestroy
+
Returns ClusterWorker<Data, Response>
+
Inherited from AbstractWorker.emitDestroy
- Defined in node_modules/@types/node/async_hooks.d.ts:311

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

`Protected` getMainWorker

Returns

Reference to the main worker.

Returns Worker

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

`Protected` handleError

handleError(e: string | Error): string
-
{@inheritDoc}
+
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

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

`Protected` messageListener

messageListener(value: MessageValue<Data, Worker>, fn: ((data: Data) => Response)): void
messageListener(message: MessageValue<Data, Worker>, fn: WorkerFunction<Data, Response>): void
+
Worker message listener.
+
Parameters
- -
  value: MessageValue<Data, Worker>
- -
  fn: ((data: Data) => Response)
  -
  - -
    - (data: Data): Response
    - -
      -
      Parameters
      -
      +
      message: MessageValue<Data, Worker>
      +
      Message received.
      +
      
      -
      data: Data
      -
      Returns 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: ((data?: Data) => Response), value: MessageValue<Data, unknown>): void
run(fn: WorkerSyncFunction<Data, Response>, message: MessageValue<Data, unknown>): void
Runs the given function synchronously.

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

Parameters
- -
  fn: ((data?: Data) => Response)
  +
  fn: WorkerSyncFunction<Data, Response>
  
  Function that will be executed.
  -
  -
  - -
    - (data?: Data): Response
    - -
      -
      Parameters
      -
      -
      -
      Optional data: Data
      -
      Returns Response
- -
  value: MessageValue<Data, unknown>
  +
  message: MessageValue<Data, unknown>
  
  Input data for the given function.
Returns void
-
Inherited from AbstractWorker.run
+
Inherited from AbstractWorker.run
- Defined in src/worker/abstract-worker.ts:169

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

`Protected` runAsync

runAsync(fn: ((data?: Data) => Promise<Response>), value: MessageValue<Data, unknown>): void
runAsync(fn: WorkerAsyncFunction<Data, Response>, message: MessageValue<Data, unknown>): void
Runs the given function asynchronously.

@@ -321,32 +307,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>
- -
  value: MessageValue<Data, unknown>
  +
  message: MessageValue<Data, unknown>
  
  Input data for the given function.
Returns void
-
Inherited from AbstractWorker.runAsync
+
Inherited from AbstractWorker.runAsync
- Defined in src/worker/abstract-worker.ts:192

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: ((this: This, ...args: any[]) => Result), thisArg?: This, ...args: any[]): 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 @@ -366,50 +341,52 @@ then restore the original execution context.

Parameters
- -
  fn: ((this: This, ...args: any[]) => Result)
  +
  fn: ((this: This, ...args: any[]) => Result)
  
  The function to call in the execution context of this async resource.
  - - (this: This, ...args: any[]): Result
    - (this: This, ...args: any[]): Result
    - Parameters
      
      -
      this: This
      +
      this: This
      
      Rest ...args: any[]
      -
      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

Defined in node_modules/.pnpm/@types+node@18.15.11/node_modules/@types/node/async_hooks.d.ts:303

`Protected` sendToMainWorker

sendToMainWorker(message: MessageValue<Response, unknown>): void
sendToMainWorker(message: MessageValue<Response, unknown>): void
-
{@inheritDoc}
+
Sends a message to the main worker.
Parameters
- -
  message: MessageValue<Response, unknown>
+
message: MessageValue<Response, unknown>
+
The response message.
+

Returns void

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

triggerAsyncId

Returns

The same triggerAsyncId that is passed to the AsyncResource constructor.

Returns number

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: Func, type?: string, thisArg?: ThisArg): Func & {
Â Â Â Â asyncResource: AsyncResource;
}
Binds the given function to the current execution context.

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

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

Parameters

-
fn: Func
+
fn: Func

The function to bind to the current execution context.
@@ -452,15 +429,16 @@ the AsyncResource to which the function is bound.

An optional name to associate with the underlying AsyncResource.
-
Optional thisArg: ThisArg