IPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=b13db3bd94fe758b1c7995771be76339065a6d93;hb=dab8c377b70fc962ec217f2aeb719842f9f94cd6;hp=0b232f29be2d00227a28ed520f67771f3a571334;hpb=6c525543a7ed67a926b7c1f4bf98985aaad1f088;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 0b232f29..b13db3bd 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier

+IPool | poolifier

@@ -18,20 +18,20 @@

Contract definition for a poolifier pool.

Type Parameters

-
Worker extends IWorker
+
Worker extends IWorker

Type of worker which manages this pool.
-
Data = unknown
+
Data = unknown

Type of data sent to the worker. This can only be serializable data.
-
Response = unknown
-
Type of response of execution. This can only be serializable data.
+
Response = unknown
+
Type of execution response. This can only be serializable data.

Hierarchy

@@ -40,9 +40,9 @@

Implemented by

AbstractPool

Defined in src/pools/pool.ts:119

@@ -50,44 +50,37 @@

Properties

busy -destroy -emitter? -execute -findFreeWorkerNodeKey -full -setWorkerChoiceStrategy -type -workerNodes +

destroy +emitter? +enableTasksQueue +execute +setTasksQueueOptions +setWorkerChoiceStrategy +setWorkerChoiceStrategyOptions +size +type +workerNodes

Properties

`Readonly` busy

busy: boolean

Whether the pool is busy or not.

The pool busyness boolean status.

destroy

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

destroy

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

Type declaration

-
- (): Promise<void>

Defined in src/pools/pool.ts:158

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Emitter on which events can be listened to.

Events that can currently be listened to:

@@ -96,67 +89,91 @@

execute

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

Defined in src/pools/pool.ts:146

enableTasksQueue

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

Type declaration

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

findFreeWorkerNodeKey

findFreeWorkerNodeKey: (() => number)

Defined in src/pools/pool.ts:183

execute

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

Type declaration

-
- (): number

`Readonly` full

full: boolean

Whether the pool is full or not.

The pool filling boolean status.

setTasksQueueOptions

setTasksQueueOptions: ((tasksQueueOptions) => void)

Type declaration

+
- (tasksQueueOptions): void
- +
  Sets the worker tasks queue options in this pool.
  +
  +
  +
  Parameters
  +
  - +
    tasksQueueOptions: TasksQueueOptions
    +
    The worker tasks queue options.
    +
  +
  Returns void

Defined in src/pools/pool.ts:192

setWorkerChoiceStrategy

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

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