X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicClusterPool.html;h=f76dcedcd075a090409f66c32ee29b50b467ed2e;hb=d3a9c958dcc326062e978f22d88747c00522032d;hp=11212b2005cb21a76266044a1d3316fcba230c16;hpb=dbf662afd2c11c4d18c4e648f90d392528a715f8;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 11212b20..f76dcedc 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,1081 +1,142 @@ -DynamicClusterPool | poolifier - v2.7.0
-
- -
-
-
-
- -

Class DynamicClusterPool<Data, Response>

-
-

A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.

+DynamicClusterPool | poolifier - v3.1.29

Class DynamicClusterPool<Data, Response>

A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.

This cluster pool creates new workers when the others are busy, up to the maximum number of workers. When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's emitter.

-
-
-

Author

Christopher Quadflieg

- +

Author

Christopher Quadflieg

Since

2.0.0

-
-
-

Type Parameters

-
    -
  • -

    Data = unknown

    -

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

    -
    -
    • -
  • -

    Response = unknown

    -

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

    -
    -
-
-

Hierarchy

-
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
emitter? -filePath -max -numberOfWorkers -opts -promiseResponseMap -workerChoiceStrategyContext -workerNodes -
-
-

Accessors

-
busy -full -info -maxSize -minSize -ready -type -utilization -worker -
-
-

Methods

-
addTaskFunction -afterTaskExecutionHook -afterWorkerNodeSetup -beforeTaskExecutionHook -checkDynamicPoolSize -createAndSetupDynamicWorkerNode -createAndSetupWorkerNode -createWorker -destroy -destroyWorkerNode -enableTasksQueue -execute -flushTasksQueue -getWorkerInfo -hasTaskFunction -hasWorkerNodeBackPressure -internalBusy -isMain -listTaskFunctionNames -registerWorkerMessageListener -removeTaskFunction -sendKillMessageToWorker -sendStartupMessageToWorker -sendToWorker -setDefaultTaskFunction -setTasksQueueOptions -setWorkerChoiceStrategy -setWorkerChoiceStrategyOptions -setupHook -start -workerListener -
-
-

Constructors

-
-

constructor

-
    - -
  • -

    Constructs a new poolifier dynamic cluster pool.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      Data = unknown

      • -
    • -

      Response = unknown

    -
    -

    Parameters

    -
      -
    • -
      min: number
      -

      Minimum number of workers which are always active.

      -
      -
      • -
    • -
      max: number
      -

      Maximum number of workers that can be created by this pool.

      -
      -
      • -
    • -
      filePath: string
      -

      Path to an implementation of a ClusterWorker file, which can be relative or absolute.

      -
      -
      • -
    • -
      opts: ClusterPoolOptions = {}
      -

      Options for this dynamic cluster pool.

      -
      -
    -

    Returns DynamicClusterPool<Data, Response>

    -
-
-

Properties

-
-

Optional Readonly emitter

-
emitter?: PoolEmitter
-

Emitter on which events can be listened to.

+

Type Parameters

  • Data = unknown

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

    +
  • Response = unknown

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

    +

Hierarchy (view full)

Constructors

constructor +

Properties

emitter? +filePath +maximumNumberOfWorkers? +minimumNumberOfWorkers +opts +promiseResponseMap +workerChoiceStrategyContext? +workerNodes +

Accessors

busy +empty +full +info +ready +type +utilization +worker +

Methods

addTaskFunction +afterTaskExecutionHook +afterWorkerNodeSetup +beforeTaskExecutionHook +checkAndEmitDynamicWorkerCreationEvents +createAndSetupDynamicWorkerNode +createAndSetupWorkerNode +deregisterWorkerMessageListener +destroy +destroyWorkerNode +enableTasksQueue +execute +flagWorkerNodeAsNotReady +flushTasksQueue +getWorkerInfo +hasTaskFunction +internalBusy +isMain +listTaskFunctionNames +registerOnceWorkerMessageListener +registerWorkerMessageListener +removeTaskFunction +sendStartupMessageToWorker +sendToWorker +setDefaultTaskFunction +setTasksQueueOptions +setWorkerChoiceStrategy +setWorkerChoiceStrategyOptions +setupHook +shallCreateDynamicWorker +start +workerMessageListener +

Constructors

constructor

Properties

Optional emitter

emitter?: EventEmitterAsyncResource

Pool event emitter integrated with async resource. +The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

Events that can currently be listened to:

    -
  • 'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
    • +
  • 'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready. If the pool is dynamic with a minimum number of workers is set to zero, this event is emitted when at least one dynamic worker is ready.
  • 'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing concurrently their tasks quota.
  • 'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
    • +
  • 'empty': Emitted when the pool is dynamic with a minimum number of workers set to zero and the number of workers has reached the minimum size expected.
  • 'destroy': Emitted when the pool is destroyed.
  • 'error': Emitted when an uncaught error occurs.
  • 'taskError': Emitted when an error occurs while executing a task.
  • 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
-
-
-
-

Protected Readonly filePath

-
filePath: string
-

Path to the worker file.

-
-
-
-

Protected Readonly max

-
max: number
-

Maximum number of workers that can be created by this pool.

-
-
-
-

Protected Readonly numberOfWorkers

-
numberOfWorkers: number
-

Number of workers that this pool should manage.

-
-
-
-

Protected Readonly opts

-
opts: ClusterPoolOptions = {}
-

Options for this fixed cluster pool.

-
-
-
-

Protected promiseResponseMap

-
promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
-

The task execution response promise map:

+

Protected Readonly filePath

filePath: string

Path to the worker file.

+

Protected Optional Readonly maximumNumberOfWorkers

maximumNumberOfWorkers?: number

Maximum number of workers that this pool manages.

+

Protected Readonly minimumNumberOfWorkers

minimumNumberOfWorkers: number

Minimum number of workers that this pool manages.

+

Protected Readonly opts

opts: PoolOptions<Worker>

Options for the pool.

+

Protected promiseResponseMap

promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...

The task execution response promise map:

  • key: The message id of each submitted task.
  • value: An object that contains the worker, the execution response promise resolve and reject callbacks.

When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.

-
-
-
-

Protected workerChoiceStrategyContext

-
workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
-

Worker choice strategy context referencing a worker choice algorithm implementation.

-
-
-
-

Readonly Internal workerNodes

-
workerNodes: IWorkerNode<Worker, Data>[] = []
-

Pool worker nodes.

-
-
-
-

Accessors

-
-

Protected busy

-

Protected Optional workerChoiceStrategyContext

workerChoiceStrategyContext?: WorkerChoiceStrategyContext<Worker, Data, Response>

Worker choice strategy context referencing a worker choice algorithm implementation.

+

Readonly Internal workerNodes

workerNodes: IWorkerNode<Worker, Data>[] = []

Pool worker nodes.

+

Accessors

Protected busy

  • get busy(): boolean

  • Whether the pool is busy or not.

    The pool busyness boolean status.

    -
    -

    Returns boolean

    -
-
-

Protected full

-

Protected empty

Protected full

  • get full(): boolean

  • Whether the pool is full or not.

    The pool filling boolean status.

    -
    -

    Returns boolean

    -
-
-

info

-
-
-

Protected maxSize

-
    -
  • get maxSize(): number
    • -
  • -

    The pool maximum size.

    -
    -

    Returns number

    -
-
-

Protected minSize

-
    -
  • get minSize(): number
    • -
  • -

    The pool minimum size.

    -
    -

    Returns number

    -
-
-

Private ready

-
    -
  • get ready(): boolean
    • -
  • -

    The pool readiness boolean status.

    -
    -

    Returns boolean

    -
-
-

Protected type

-

info

Private ready

Protected type

  • get type(): "fixed" | "dynamic"

  • The pool type.

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

    -
    -

    Returns "fixed" | "dynamic"

    -
-
-

Private utilization

-
    -
  • get utilization(): number
    • -
  • -

    The approximate pool utilization.

    -
    -

    Returns number

    The pool utilization.

    - -
-
-

Protected worker

-
    -
  • get worker(): "thread" | "cluster"
    • -
  • -

    The worker type.

    -
    -

    Returns "thread" | "cluster"

    -
-
-

Methods

-
-

addTaskFunction

-
-
-

Protected afterTaskExecutionHook

-
    - -
  • -

    Hook executed after the worker task execution. +

    Returns "fixed" | "dynamic"

Private utilization

  • get utilization(): number

  • The approximate pool utilization.

    +

    Returns number

    The pool utilization.

    +

Protected worker

  • get worker(): "thread" | "cluster"

  • The worker type.

    +

    Returns "thread" | "cluster"

Methods

addTaskFunction

Protected afterTaskExecutionHook

-
-

Protected afterWorkerNodeSetup

-

Protected afterWorkerNodeSetup

-
-

Protected beforeTaskExecutionHook

-

Protected beforeTaskExecutionHook

-
-

Protected checkDynamicPoolSize

-
-
-

Protected createAndSetupDynamicWorkerNode

-
-
-

Protected createAndSetupWorkerNode

-
-
-

Protected createWorker

-
-
-

destroy

-
-
-

Protected destroyWorkerNode

-
-
-

enableTasksQueue

-
    - -
  • -

    Enables/disables the worker node tasks queue in this pool.

    -
    -
    -

    Parameters

    -
      -
    • -
      enable: boolean
      -

      Whether to enable or disable the worker node tasks queue.

      -
      -
      • -
    • -
      Optional tasksQueueOptions: TasksQueueOptions
      -

      The worker node tasks queue options.

      -
      -
    -

    Returns void

    -
-
-

execute

-
    - -
  • -

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

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional data: Data
      -

      The optional task input data for the specified task function. This can only be structured-cloneable data.

      -
      -
      • -
    • -
      Optional name: string
      -

      The optional name of the task function to execute. If not specified, the default task function will be executed.

      -
      -
      • -
    • -
      Optional transferList: TransferListItem[]
      -

      An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.

      -
      -
    -

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

    - -
-
-

Protected flushTasksQueue

-
-
-

Protected getWorkerInfo

-
-
-

hasTaskFunction

-
    - -
  • -

    Whether the specified task function exists in this pool.

    -
    -
    -

    Parameters

    -
      -
    • -
      name: string
      -

      The name of the task function.

      -
      -
    -

    Returns boolean

    true if the task function exists, false otherwise.

    - -
-
-

hasWorkerNodeBackPressure

-
    - -
  • Internal -

    Whether the worker node has back pressure (i.e. its tasks queue is full).

    -
    -
    -

    Parameters

    -
      -
    • -
      workerNodeKey: number
      -

      The worker node key.

      -
      -
    -

    Returns boolean

    true if the worker node has back pressure, false otherwise.

    - -
-
-

Protected internalBusy

-
-
-

Protected isMain

-
-
-

listTaskFunctionNames

-
-
-

Protected registerWorkerMessageListener

-
    - -
  • -

    Registers a listener callback on the worker given its worker node key.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      Message

    -
    -

    Parameters

    -
      -
    • -
      workerNodeKey: number
      -

      The worker node key.

      -
      -
      • -
    • -
      listener: ((message) => void)
      -

      The message listener callback.

      -
      -
      -
        -
      • -
          -
        • (message): void
          • -
        • -
          -

          Parameters

          -
          -

          Returns void

    -

    Returns void

    -
-
-

removeTaskFunction

-
    - -
  • -

    Removes a task function from this pool.

    -
    -
    -

    Parameters

    -
      -
    • -
      name: string
      -

      The name of the task function.

      -
      -
    -

    Returns Promise<boolean>

    true if the task function was removed, false otherwise.

    - -
-
-

Protected sendKillMessageToWorker

-
-
-

Protected sendStartupMessageToWorker

-
-
-

Protected sendToWorker

-
-
-

setDefaultTaskFunction

-
    - -
  • -

    Sets the default task function in this pool.

    -
    -
    -

    Parameters

    -
      -
    • -
      name: string
      -

      The name of the task function.

      -
      -
    -

    Returns Promise<boolean>

    true if the default task function was set, false otherwise.

    - -
-
-

setTasksQueueOptions

-
-
-

setWorkerChoiceStrategy

-
    - -
  • -

    Sets the worker choice strategy in this pool.

    -
    -
    -

    Parameters

    -
      -
    • -
      workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
      -

      The worker choice strategy.

      -
      -
      • -
    • -
      Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
      -

      The worker choice strategy options.

      -
      -
    -

    Returns void

    -
-
-

setWorkerChoiceStrategyOptions

-
-
-

Protected setupHook

-

Protected checkAndEmitDynamicWorkerCreationEvents

Protected createAndSetupDynamicWorkerNode

Protected createAndSetupWorkerNode

Protected deregisterWorkerMessageListener

destroy

Protected destroyWorkerNode

enableTasksQueue

execute

Protected flagWorkerNodeAsNotReady

Protected flushTasksQueue

Protected getWorkerInfo

hasTaskFunction

Protected internalBusy

Protected isMain

listTaskFunctionNames

Protected registerOnceWorkerMessageListener

Protected registerWorkerMessageListener

removeTaskFunction

Protected sendStartupMessageToWorker

Protected sendToWorker

setDefaultTaskFunction

setTasksQueueOptions

setWorkerChoiceStrategy

setWorkerChoiceStrategyOptions

Protected setupHook

-
-

start

-
-
-

Protected workerListener

-
    - -
  • -

    This method is the listener registered for each worker message.

    -
    -

    Returns ((message) => void)

    The listener function to execute when a message is received from a worker.

    - -
      -
    • -
        -
      • (message): void
        • -
      • -

        This method is the listener registered for each worker message.

        -
        -
        -

        Parameters

        -
        -

        Returns void

        The listener function to execute when a message is received from a worker.

        - -
    -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Returns void

Protected shallCreateDynamicWorker

start

Protected Readonly workerMessageListener

Settings

Member Visibility

Theme

On This Page

constructoremitterfilePathmaximumNumberOfWorkersminimumNumberOfWorkersoptspromiseResponseMapworkerChoiceStrategyContextworkerNodesbusyemptyfullinforeadytypeutilizationworkeraddTaskFunctionafterTaskExecutionHookafterWorkerNodeSetupbeforeTaskExecutionHookcheckAndEmitDynamicWorkerCreationEventscreateAndSetupDynamicWorkerNodecreateAndSetupWorkerNodederegisterWorkerMessageListenerdestroydestroyWorkerNodeenableTasksQueueexecuteflagWorkerNodeAsNotReadyflushTasksQueuegetWorkerInfohasTaskFunctioninternalBusyisMainlistTaskFunctionNamesregisterOnceWorkerMessageListenerregisterWorkerMessageListenerremoveTaskFunctionsendStartupMessageToWorkersendToWorkersetDefaultTaskFunctionsetTasksQueueOptionssetWorkerChoiceStrategysetWorkerChoiceStrategyOptionssetupHookshallCreateDynamicWorkerstartworkerMessageListener

Generated using TypeDoc

\ No newline at end of file