IPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=602223db367cf746ba3d206587e7527035c5ab88;hb=a97f9c80aa49c6152547fb6fa8de4b0f089c2353;hp=aa5596f711a877e710877db71812c816ad591700;hpb=bb3f9b66fa2241864d31937eeced22caab83d17e;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index aa5596f7..602223db 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier

+IPool | poolifier

Contract definition for a poolifier pool.

+ +

Type Parameters

+
Worker extends IWorker
+
Type of worker which manages this pool.
+
+
-
Data = unknown
-
Type of data sent to the worker. This can only be serializable data.
-

Data = unknown

Type of data sent to the worker. This can only be structured-cloneable data.

-
Response = unknown
-
Type of response of execution. This can only be serializable data.
-

Response = unknown

Type of execution response. This can only be structured-cloneable data.

Hierarchy

IPool

@@ -42,73 +54,149 @@

Properties

destroy -emitter? -execute -setWorkerChoiceStrategy +

destroy +emitter? +enableTasksQueue +execute +info +setTasksQueueOptions +setWorkerChoiceStrategy +setWorkerChoiceStrategyOptions +workerNodes

Properties

destroy

destroy: (() => Promise<void>)

destroy

destroy: (() => Promise<void>)

Type declaration

-
- (): Promise<void>

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Defined in src/pools/pool.ts:193

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Emitter on which events can be listened to.

Events that can currently be listened to:

'full': Emitted when the pool is dynamic and full.
'busy': Emitted when the pool is busy.
'error': Emitted when an uncaught error occurs.
'taskError': Emitted when an error occurs while executing a task.

enableTasksQueue

enableTasksQueue: ((enable, tasksQueueOptions?) => void)

Type declaration

+
- (enable, tasksQueueOptions?): void
- +
  Enables/disables the worker tasks queue in this pool.
  +
  +
  +
  Parameters
  +
  - +
    enable: boolean
    +
    Whether to enable or disable the worker tasks queue.
    +
    +
  - +
    Optional tasksQueueOptions: TasksQueueOptions
    +
    The worker tasks queue options.
    +
    +
  +
  Returns void
  +

execute

execute: ((data: Data) => Promise<Response>)

Defined in src/pools/pool.ts:218

execute

execute: ((data?, name?) => Promise<Response>)

Type declaration

-
- (data: Data): Promise<Response>

`Readonly` info

info: PoolInfo

Pool information.

setTasksQueueOptions

setTasksQueueOptions: ((tasksQueueOptions) => void)

Type declaration

+
- (tasksQueueOptions): void
- +
  Sets the worker tasks queue options in this pool.
  Parameters
  - -
    data: Data
    -
    The input for the specified task. This can only be serializable data.
    -
  -
  Returns Promise<Response>

setWorkerChoiceStrategy

setWorkerChoiceStrategy: ((workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN") => void)

Defined in src/pools/pool.ts:227

setWorkerChoiceStrategy

setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)

Type declaration

-
- (workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void

Returns void

setWorkerChoiceStrategyOptions

setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)

Type declaration

+
- (workerChoiceStrategyOptions): void
- +
  Sets the worker choice strategy options in this pool.
  +
  +
  +
  Parameters
  +
  - +
    workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
    +
    The worker choice strategy options.
    +
    +
  +
  Returns void
  +