X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=d2afab17aafc0ad98c26178a0e85ce14c8461062;hb=2493c34370d0839614058bb55254fd7aec91b664;hp=d6886db855eb4871086c71c29aa4e5815fe75182;hpb=7d766fdcc503b3ad3ab1db98e569cd7d98becd66;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index d6886db8..d2afab17 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,8 +1,8 @@ -AbstractPool | poolifier - v4.0.8

Class AbstractPool<Worker, Data, Response>Abstract

Base class that implements some shared logic for all poolifier pools.

+AbstractPool | poolifier - v4.0.11

Class AbstractPool<Worker, Data, Response>Abstract

Base class that implements some shared logic for all poolifier pools.

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 structured-cloneable data.

  • Response = unknown

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

    -

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

destroying emitter? filePath @@ -114,8 +114,8 @@
  • filePath: string

    Path to the worker file.

  • opts: PoolOptions<Worker>

    Options for the pool.

  • Optional maximumNumberOfWorkers: number

    Maximum number of workers that this pool manages.

    -

    • Returns AbstractPool<Worker, Data, Response>

    Properties

    Private destroying

    destroying: boolean

    Whether the pool is destroying or not.

    -

    Optional emitter

    emitter?: EventEmitterAsyncResource

    Pool event emitter integrated with async resource. +

    Returns AbstractPool<Worker, Data, Response>

    Properties

    Private destroying

    destroying: boolean

    Whether the pool is destroying or not.

    +

    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:

      @@ -128,124 +128,124 @@ 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}-${string}-${string}-${string}-${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}-${string}-${string}-${string}-${string}`, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

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

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

    -

    Private readyEventEmitted

    readyEventEmitted: boolean

    Whether the pool ready event has been emitted or not.

    -

    Private Optional startTimestamp

    startTimestamp?: number

    The start timestamp of the pool.

    -

    Private started

    started: boolean

    Whether the pool is started or not.

    -

    Private starting

    starting: boolean

    Whether the pool is starting or not.

    -

    Private startingMinimumNumberOfWorkers

    startingMinimumNumberOfWorkers: boolean

    Whether the minimum number of workers is starting or not.

    -

    Private Readonly taskFunctions

    taskFunctions: Map<string, TaskFunctionObject<Data, Response>>

    The task functions added at runtime map:

    +

    Private readyEventEmitted

    readyEventEmitted: boolean

    Whether the pool ready event has been emitted or not.

    +

    Private Optional startTimestamp

    startTimestamp?: number

    The start timestamp of the pool.

    +

    Private started

    started: boolean

    Whether the pool is started or not.

    +

    Private starting

    starting: boolean

    Whether the pool is starting or not.

    +

    Private startingMinimumNumberOfWorkers

    startingMinimumNumberOfWorkers: boolean

    Whether the minimum number of workers is starting or not.

    +

    Private Readonly taskFunctions

    taskFunctions: Map<string, TaskFunctionObject<Data, Response>>

    The task functions added at runtime map:

    • key: The task function name.
    • value: The task function object.
    -

    Protected Optional workerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms implementation.

    -

    Readonly Internal workerNodes

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

    Pool worker nodes.

    -

    Accessors

    Protected Abstract busy

    Protected Optional workerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms implementation.

    +

    Readonly Internal workerNodes

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

    Pool worker nodes.

    +

    Accessors

    Protected Abstract busy

    Protected empty

    Protected full

    Protected empty

    Protected full

    info

    Private ready

    Protected Abstract type

    info

    Private ready

    Protected Abstract type

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

    • The pool type.

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

      -

      Returns "fixed" | "dynamic"

    Private utilization

    Private utilization

    Protected Abstract worker

    Methods

    addTaskFunction

    Private addWorkerNode

    Protected Abstract worker

    Methods

    addTaskFunction

    Private addWorkerNode

    Protected afterTaskExecutionHook

    Protected afterTaskExecutionHook

    • afterTaskExecutionHook(workerNodeKey, message): void

    • Hook executed after the worker task execution. Can be overridden.

      Parameters

      • workerNodeKey: number

        The worker node key.

      • message: MessageValue<Response, unknown>

        The received message.

        -

      Returns void

    Protected afterWorkerNodeSetup

    • afterWorkerNodeSetup(workerNodeKey): void

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

    Returns void

    Protected afterWorkerNodeSetup

    • afterWorkerNodeSetup(workerNodeKey): void

    • Method hooked up after a worker node has been newly created. Can be overridden.

      Parameters

      • workerNodeKey: number

        The newly created worker node key.

        -

      Returns void

    Protected beforeTaskExecutionHook

    • beforeTaskExecutionHook(workerNodeKey, task): void

    • Hook executed before the worker task execution. +

    Returns void

    Protected beforeTaskExecutionHook

    • beforeTaskExecutionHook(workerNodeKey, task): void

    • Hook executed before the worker task execution. Can be overridden.

      Parameters

      • workerNodeKey: number

        The worker node key.

      • task: Task<Data>

        The task to execute.

        -

      Returns void

    Private buildTasksQueueOptions

    Private cannotStealTask

    Protected Abstract checkAndEmitDynamicWorkerCreationEvents

    Private checkAndEmitEmptyEvent

    Private checkAndEmitReadyEvent

    Private checkAndEmitTaskExecutionEvents

    Private checkAndEmitTaskQueuingEvents

    Private checkMessageWorkerId

    • checkMessageWorkerId(message): void

    • Checks if the worker id sent in the received message from a worker is valid.

      +

    Returns void

    Private buildTasksQueueOptions

    Private cannotStealTask

    Protected Abstract checkAndEmitDynamicWorkerCreationEvents

    Private checkAndEmitEmptyEvent

    Private checkAndEmitReadyEvent

    Private checkAndEmitTaskExecutionEvents

    Private checkAndEmitTaskQueuingEvents

    Private checkMessageWorkerId

    Private checkMinimumNumberOfWorkers

    Private checkPoolOptions

    Private checkPoolType

    Private checkValidWorkerChoiceStrategyOptions

    Private chooseWorkerNode

    Private checkMinimumNumberOfWorkers

    Private checkPoolOptions

    Private checkPoolType

    Private checkValidWorkerChoiceStrategyOptions

    Private chooseWorkerNode

    Protected createAndSetupDynamicWorkerNode

    Protected createAndSetupDynamicWorkerNode

    Protected createAndSetupWorkerNode

    Protected createAndSetupWorkerNode

    Private createWorkerNode

    Private createWorkerNode

    Private dequeueTask

    Protected Abstract deregisterWorkerMessageListener

    Private dequeueTask

    Protected Abstract deregisterWorkerMessageListener

    destroy

    Protected destroyWorkerNode

    Returns void

    destroy

    Protected destroyWorkerNode

    enableTasksQueue

    Private enqueueTask

    execute

    Private executeTask

    Returns Promise<void>

    enableTasksQueue

    Private enqueueTask

    execute

    Private executeTask

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Private flushTasksQueues

    Private Readonly getTaskFunctionWorkerChoiceStrategy

    Returns void

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Private flushTasksQueues

    Private Readonly getTaskFunctionWorkerChoiceStrategy

    Private Readonly getWorkerChoiceStrategies

    Private Readonly getWorkerChoiceStrategies

    Protected getWorkerInfo

    Protected getWorkerInfo

    Private getWorkerNodeKeyByWorkerId

    Private getWorkerNodeKeyByWorkerId

    Private Readonly getWorkerNodeTaskFunctionPriority

    Private Readonly getWorkerNodeTaskFunctionPriority

    Private Readonly getWorkerNodeTaskFunctionWorkerChoiceStrategy

    Private Readonly getWorkerNodeTaskFunctionWorkerChoiceStrategy

    Private handleTask

    Private handleTaskExecutionResponse

    Private Readonly handleWorkerNodeBackPressureEvent

    Private Readonly handleWorkerNodeIdleEvent

    Private handleWorkerReadyResponse

    Private hasBackPressure

    hasTaskFunction

    Private initEventEmitter

    Private initWorkerNodeUsage

    Private handleTask

    Private handleTaskExecutionResponse

    Private Readonly handleWorkerNodeBackPressureEvent

    Private Readonly handleWorkerNodeIdleEvent

    Private handleWorkerReadyResponse

    Private hasBackPressure

    hasTaskFunction

    Private initEventEmitter

    Private initWorkerNodeUsage

    Protected internalBusy

    Returns void

    Protected internalBusy

    Protected Abstract isMain

    Protected Abstract isMain

    Private isWorkerNodeBusy

    listTaskFunctionsProperties

    Private redistributeQueuedTasks

    Protected Abstract registerOnceWorkerMessageListener

    Private isWorkerNodeBusy

    listTaskFunctionsProperties

    Private redistributeQueuedTasks

    Protected Abstract registerOnceWorkerMessageListener

    Protected Abstract registerWorkerMessageListener

    Returns void

    Protected Abstract registerWorkerMessageListener

    removeTaskFunction

    Private removeWorkerNode

    Returns void

    removeTaskFunction

    Private removeWorkerNode

    Private resetTaskSequentiallyStolenStatisticsWorkerUsage

    Private sendKillMessageToWorker

    Protected Abstract sendStartupMessageToWorker

    Returns void

    Private resetTaskSequentiallyStolenStatisticsWorkerUsage

    Private sendKillMessageToWorker

    Protected Abstract sendStartupMessageToWorker

    Private sendStatisticsMessageToWorker

    Returns void

    Private sendStatisticsMessageToWorker

    Private sendTaskFunctionOperationToWorker

    Private sendTaskFunctionOperationToWorkers

    Protected Abstract sendToWorker

    Returns void

    Private sendTaskFunctionOperationToWorker

    Private sendTaskFunctionOperationToWorkers

    Protected Abstract sendToWorker

    setDefaultTaskFunction

    Private setTaskStealing

    setTasksQueueOptions

    Private setTasksQueueSize

    Private setTasksStealingOnBackPressure

    setWorkerChoiceStrategy

    setWorkerChoiceStrategyOptions

    Protected setupHook

    Returns void

    setDefaultTaskFunction

    Private setTaskStealing

    setTasksQueueOptions

    Private setTasksQueueSize

    Private setTasksStealingOnBackPressure

    setWorkerChoiceStrategy

    setWorkerChoiceStrategyOptions

    Protected setupHook

    Protected Abstract shallCreateDynamicWorker

    Protected Abstract shallCreateDynamicWorker

    Private shallExecuteTask

    Private shallUpdateTaskFunctionWorkerUsage

    Private shallExecuteTask

    Private shallUpdateTaskFunctionWorkerUsage

    start

    Private startMinimumNumberOfWorkers

    Private tasksQueueSize

    Private unsetTaskStealing

    Private unsetTasksStealingOnBackPressure

    Private updateTaskSequentiallyStolenStatisticsWorkerUsage

    Private updateTaskStolenStatisticsWorkerUsage

    Protected Readonly workerMessageListener

    Private Readonly workerNodeStealTask

    Settings

    Member Visibility

    Theme

    On This Page

    constructordestroyingemitterfilePathmaximumNumberOfWorkersminimumNumberOfWorkersoptspromiseResponseMapreadyEventEmittedstartTimestampstartedstartingstartingMinimumNumberOfWorkerstaskFunctionsworkerChoiceStrategiesContextworkerNodesbusyemptyfullinforeadytypeutilizationworkeraddTaskFunctionaddWorkerNodeafterTaskExecutionHookafterWorkerNodeSetupbeforeTaskExecutionHookbuildTasksQueueOptionscannotStealTaskcheckAndEmitDynamicWorkerCreationEventscheckAndEmitEmptyEventcheckAndEmitReadyEventcheckAndEmitTaskExecutionEventscheckAndEmitTaskQueuingEventscheckMessageWorkerIdcheckMinimumNumberOfWorkerscheckPoolOptionscheckPoolTypecheckValidWorkerChoiceStrategyOptionschooseWorkerNodecreateAndSetupDynamicWorkerNodecreateAndSetupWorkerNodecreateWorkerNodedequeueTaskderegisterWorkerMessageListenerdestroydestroyWorkerNodeenableTasksQueueenqueueTaskexecuteexecuteTaskflagWorkerNodeAsNotReadyflushTasksQueueflushTasksQueuesgetTaskFunctionWorkerChoiceStrategygetWorkerChoiceStrategiesgetWorkerInfogetWorkerNodeKeyByWorkerIdgetWorkerNodeTaskFunctionPrioritygetWorkerNodeTaskFunctionWorkerChoiceStrategyhandleTaskhandleTaskExecutionResponsehandleWorkerNodeBackPressureEventhandleWorkerNodeIdleEventhandleWorkerReadyResponsehasBackPressurehasTaskFunctioninitEventEmitterinitWorkerNodeUsageinternalBusyisMainisWorkerNodeBusylistTaskFunctionsPropertiesredistributeQueuedTasksregisterOnceWorkerMessageListenerregisterWorkerMessageListenerremoveTaskFunctionremoveWorkerNoderesetTaskSequentiallyStolenStatisticsWorkerUsagesendKillMessageToWorkersendStartupMessageToWorkersendStatisticsMessageToWorkersendTaskFunctionOperationToWorkersendTaskFunctionOperationToWorkerssendToWorkersetDefaultTaskFunctionsetTaskStealingsetTasksQueueOptionssetTasksQueueSizesetTasksStealingOnBackPressuresetWorkerChoiceStrategysetWorkerChoiceStrategyOptionssetupHookshallCreateDynamicWorkershallExecuteTaskshallUpdateTaskFunctionWorkerUsagestartstartMinimumNumberOfWorkerstasksQueueSizeunsetTaskStealingunsetTasksStealingOnBackPressureupdateTaskSequentiallyStolenStatisticsWorkerUsageupdateTaskStolenStatisticsWorkerUsageworkerMessageListenerworkerNodeStealTask
    \ No newline at end of file +

    start

    Private startMinimumNumberOfWorkers

    Private tasksQueueSize

    Private unsetTaskStealing

    Private unsetTasksStealingOnBackPressure

    Private updateTaskSequentiallyStolenStatisticsWorkerUsage

    Private updateTaskStolenStatisticsWorkerUsage

    Protected Readonly workerMessageListener

    Private Readonly workerNodeStealTask

    Settings

    Member Visibility

    Theme

    On This Page

    constructordestroyingemitterfilePathmaximumNumberOfWorkersminimumNumberOfWorkersoptspromiseResponseMapreadyEventEmittedstartTimestampstartedstartingstartingMinimumNumberOfWorkerstaskFunctionsworkerChoiceStrategiesContextworkerNodesbusyemptyfullinforeadytypeutilizationworkeraddTaskFunctionaddWorkerNodeafterTaskExecutionHookafterWorkerNodeSetupbeforeTaskExecutionHookbuildTasksQueueOptionscannotStealTaskcheckAndEmitDynamicWorkerCreationEventscheckAndEmitEmptyEventcheckAndEmitReadyEventcheckAndEmitTaskExecutionEventscheckAndEmitTaskQueuingEventscheckMessageWorkerIdcheckMinimumNumberOfWorkerscheckPoolOptionscheckPoolTypecheckValidWorkerChoiceStrategyOptionschooseWorkerNodecreateAndSetupDynamicWorkerNodecreateAndSetupWorkerNodecreateWorkerNodedequeueTaskderegisterWorkerMessageListenerdestroydestroyWorkerNodeenableTasksQueueenqueueTaskexecuteexecuteTaskflagWorkerNodeAsNotReadyflushTasksQueueflushTasksQueuesgetTaskFunctionWorkerChoiceStrategygetWorkerChoiceStrategiesgetWorkerInfogetWorkerNodeKeyByWorkerIdgetWorkerNodeTaskFunctionPrioritygetWorkerNodeTaskFunctionWorkerChoiceStrategyhandleTaskhandleTaskExecutionResponsehandleWorkerNodeBackPressureEventhandleWorkerNodeIdleEventhandleWorkerReadyResponsehasBackPressurehasTaskFunctioninitEventEmitterinitWorkerNodeUsageinternalBusyisMainisWorkerNodeBusylistTaskFunctionsPropertiesredistributeQueuedTasksregisterOnceWorkerMessageListenerregisterWorkerMessageListenerremoveTaskFunctionremoveWorkerNoderesetTaskSequentiallyStolenStatisticsWorkerUsagesendKillMessageToWorkersendStartupMessageToWorkersendStatisticsMessageToWorkersendTaskFunctionOperationToWorkersendTaskFunctionOperationToWorkerssendToWorkersetDefaultTaskFunctionsetTaskStealingsetTasksQueueOptionssetTasksQueueSizesetTasksStealingOnBackPressuresetWorkerChoiceStrategysetWorkerChoiceStrategyOptionssetupHookshallCreateDynamicWorkershallExecuteTaskshallUpdateTaskFunctionWorkerUsagestartstartMinimumNumberOfWorkerstasksQueueSizeunsetTaskStealingunsetTasksStealingOnBackPressureupdateTaskSequentiallyStolenStatisticsWorkerUsageupdateTaskStolenStatisticsWorkerUsageworkerMessageListenerworkerNodeStealTask
    \ No newline at end of file