Interface IPool<Worker, Data, Response>

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.

  • Response = unknown

    Type of execution response. This can only be serializable data.

Hierarchy

  • IPool

Implemented by

Properties

destroy emitter? enableTasksQueue execute findFreeWorkerNodeKey setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions type workerNodes

Properties

destroy

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

Type declaration

    • (): Promise<void>

    • Shutdowns every current worker in this pool.

      Returns Promise<void>

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.

enableTasksQueue

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

Type declaration

    • (enable: boolean, tasksQueueOptions?: 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>)

Type declaration

    • (data: Data): Promise<Response>

    • Executes the function specified in the constructor with the task data input parameter.

      Returns

      Promise that will be resolved when the task is successfully completed.

      Parameters

      • data: Data

        The task input data for the specified function. This can only be serializable data.

      Returns Promise<Response>

findFreeWorkerNodeKey

findFreeWorkerNodeKey: (() => number)

Type declaration

    • (): number

    • Finds a free worker node key based on the number of tasks the worker has applied.

      If a worker is found with 0 running tasks, it is detected as free and its worker node key is returned.

      If no free worker is found, -1 is returned.

      Returns

      A worker node key if there is one, -1 otherwise.

      Returns number

setTasksQueueOptions

setTasksQueueOptions: ((tasksQueueOptions: TasksQueueOptions) => void)

Type declaration

    • (tasksQueueOptions: TasksQueueOptions): void

    • Sets the worker tasks queue options in this pool.

      Parameters

      Returns void

setWorkerChoiceStrategy

setWorkerChoiceStrategy: ((workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions) => void)

Type declaration

    • (workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions): void

    • Sets the worker choice strategy in this pool.

      Parameters

      • workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

        The worker choice strategy.

      • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

        The worker choice strategy options.

      Returns void

setWorkerChoiceStrategyOptions

setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions: WorkerChoiceStrategyOptions) => void)

Type declaration

Readonly type

type: PoolType

Pool type.

If it is 'dynamic', it provides the max property.

Readonly workerNodes

workerNodes: WorkerNode<Worker, Data>[]

Pool worker nodes.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc