X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=4b2b9b4a9fe1e15c99c5d998d5070ccf6d5f2ce0;hb=a99f06d1fff8949584cd630bfaa3fa2e3cc3897e;hp=ed787a185bb5273d3d1d81818750d688ba33629f;hpb=cf4c4b77d31b88b45c9f876f6fab553e66000f4d;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index ed787a18..4b2b9b4a 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,9 +1,9 @@ -FixedClusterPool | poolifier - v3.1.22

Class FixedClusterPool<Data, Response>

A cluster pool with a fixed number of workers.

+FixedClusterPool | poolifier - v3.1.27

Class FixedClusterPool<Data, Response>

A cluster pool with a fixed number of workers.

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 (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

emitter? filePath maximumNumberOfWorkers? @@ -56,7 +56,7 @@

Type Parameters

  • Data = unknown
  • Response = unknown

Parameters

  • numberOfWorkers: number

    Number of workers for this pool.

  • filePath: string

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

  • opts: ClusterPoolOptions = {}

    Options for this fixed cluster pool.

    -
  • Optional maximumNumberOfWorkers: number

Returns FixedClusterPool<Data, Response>

Properties

Optional emitter

emitter?: EventEmitterAsyncResource

Pool event emitter integrated with async resource. +

  • Optional maximumNumberOfWorkers: number

    • Returns FixedClusterPool<Data, Response>

    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:

      @@ -69,71 +69,71 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    • '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 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:

    +

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

    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 empty

    Protected full

    Protected empty

    Protected full

    • get full(): boolean

    • Whether the pool is full or not.

      The pool filling boolean status.

      -

      Returns boolean

    info

    Private ready

    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 "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

    • afterTaskExecutionHook(workerNodeKey, message): void

    • Hook executed after the worker task execution. +

    Protected worker

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

    • The worker type.

      +

      Returns "thread" | "cluster"

    Methods

    addTaskFunction

    Protected afterTaskExecutionHook

    Protected afterWorkerNodeSetup

    • afterWorkerNodeSetup(workerNodeKey): void

    • Method hooked up after a worker node has been newly created. +

    Returns void

    Protected afterWorkerNodeSetup

    Protected beforeTaskExecutionHook

    • beforeTaskExecutionHook(workerNodeKey, task): void

    • Hook executed before the worker task execution. +

    Returns void

    Protected beforeTaskExecutionHook

    Protected checkAndEmitDynamicWorkerCreationEvents

    Protected createAndSetupDynamicWorkerNode

    • createAndSetupDynamicWorkerNode(): number

    • Creates a new, completely set up dynamic worker node.

      +

    Returns void

    Protected checkAndEmitDynamicWorkerCreationEvents

    Protected createAndSetupDynamicWorkerNode

    Protected createAndSetupWorkerNode

    Protected createAndSetupWorkerNode

    Protected deregisterWorkerMessageListener

    Protected deregisterWorkerMessageListener

    destroy

    Protected destroyWorkerNode

    Returns void

    destroy

    Protected destroyWorkerNode

    enableTasksQueue

    execute

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    Returns Promise<void>

    enableTasksQueue

    execute

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    hasTaskFunction

    Protected internalBusy

    hasTaskFunction

    Protected internalBusy

    Protected isMain

    listTaskFunctionNames

    Protected registerOnceWorkerMessageListener

    Protected isMain

    listTaskFunctionNames

    Protected registerOnceWorkerMessageListener

    Protected registerWorkerMessageListener

    Returns void

    Protected registerWorkerMessageListener

    removeTaskFunction

    Protected sendStartupMessageToWorker

    Returns void

    removeTaskFunction

    Protected sendStartupMessageToWorker

    Protected sendToWorker

    Returns void

    Protected sendToWorker

    setDefaultTaskFunction

    setTasksQueueOptions

    setWorkerChoiceStrategy

    setWorkerChoiceStrategyOptions

    Protected setupHook

    Returns void

    setDefaultTaskFunction

    setTasksQueueOptions

    setWorkerChoiceStrategy

    setWorkerChoiceStrategyOptions

    Protected setupHook

    Protected shallCreateDynamicWorker

    Protected shallCreateDynamicWorker

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    constructoremitterfilePathmaximumNumberOfWorkersminimumNumberOfWorkersoptspromiseResponseMapworkerChoiceStrategyContextworkerNodesbusyemptyfullinforeadytypeutilizationworkeraddTaskFunctionafterTaskExecutionHookafterWorkerNodeSetupbeforeTaskExecutionHookcheckAndEmitDynamicWorkerCreationEventscreateAndSetupDynamicWorkerNodecreateAndSetupWorkerNodederegisterWorkerMessageListenerdestroydestroyWorkerNodeenableTasksQueueexecuteflagWorkerNodeAsNotReadyflushTasksQueuegetWorkerInfohasTaskFunctioninternalBusyisMainlistTaskFunctionNamesregisterOnceWorkerMessageListenerregisterWorkerMessageListenerremoveTaskFunctionsendStartupMessageToWorkersendToWorkersetDefaultTaskFunctionsetTasksQueueOptionssetWorkerChoiceStrategysetWorkerChoiceStrategyOptionssetupHookshallCreateDynamicWorkerstartworkerMessageListener

    Generated using TypeDoc

    \ No newline at end of file +

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    constructoremitterfilePathmaximumNumberOfWorkersminimumNumberOfWorkersoptspromiseResponseMapworkerChoiceStrategyContextworkerNodesbusyemptyfullinforeadytypeutilizationworkeraddTaskFunctionafterTaskExecutionHookafterWorkerNodeSetupbeforeTaskExecutionHookcheckAndEmitDynamicWorkerCreationEventscreateAndSetupDynamicWorkerNodecreateAndSetupWorkerNodederegisterWorkerMessageListenerdestroydestroyWorkerNodeenableTasksQueueexecuteflagWorkerNodeAsNotReadyflushTasksQueuegetWorkerInfohasTaskFunctioninternalBusyisMainlistTaskFunctionNamesregisterOnceWorkerMessageListenerregisterWorkerMessageListenerremoveTaskFunctionsendStartupMessageToWorkersendToWorkersetDefaultTaskFunctionsetTasksQueueOptionssetWorkerChoiceStrategysetWorkerChoiceStrategyOptionssetupHookshallCreateDynamicWorkerstartworkerMessageListener

    Generated using TypeDoc

    \ No newline at end of file