X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=57019215eab51531af8a99c7d0f472ca09bc6c9b;hb=25926072f5397949802f6af5a2f7d49d6f15cacc;hp=46d2b3f6752156f0729fa675f5483a4abe9959ea;hpb=89757908a0cf61d60dcf28323c5c23c4ef66fcf2;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 46d2b3f6..57019215 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,13 +1,13 @@ -AbstractPool | poolifier - v2.6.26
+AbstractPool | poolifier - v2.7.4
-
+
  • The search index is not available
  • poolifier - v2.7.4 +
    @@ -49,24 +49,26 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:64
  • - +

    Constructors

    -

    Properties

    -

    Accessors

    -
    busy +
    busy full info maxSize @@ -86,25 +88,26 @@

    Methods

    -
    addWorkerNode +
    addTaskFunction +addWorkerNode afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook buildTasksQueueOptions -checkAndEmitEvents -checkDynamicPoolSize -checkFilePath +checkAndEmitDynamicWorkerCreationEvents +checkAndEmitTaskExecutionEvents +checkAndEmitTaskQueuingEvents checkMessageWorkerId checkNumberOfWorkers checkPoolOptions -checkValidTasksQueueOptions -checkValidWorkerChoiceStrategy checkValidWorkerChoiceStrategyOptions chooseWorkerNode createAndSetupDynamicWorkerNode createAndSetupWorkerNode createWorker +deleteTaskFunctionWorkerUsages dequeueTask +deregisterWorkerMessageListener destroy destroyWorkerNode enableTasksQueue @@ -118,33 +121,52 @@ getWorkerNodeKeyByWorkerId handleTaskExecutionResponse handleWorkerReadyResponse +hasBackPressure +hasTaskFunction +hasWorkerNodeBackPressure +initializeEventEmitter internalBusy isMain -listTaskFunctions +listTaskFunctionNames redistributeQueuedTasks +registerOnceWorkerMessageListener registerWorkerMessageListener +removeTaskFunction removeWorkerNode sendKillMessageToWorker sendStartupMessageToWorker sendStatisticsMessageToWorker +sendTaskFunctionOperationToWorker +sendTaskFunctionOperationToWorkers sendToWorker +setDefaultTaskFunction +setTaskStealing setTasksQueueOptions +setTasksQueueSize +setTasksStealingOnBackPressure setWorkerChoiceStrategy setWorkerChoiceStrategyOptions setupHook shallCreateDynamicWorker -startPool +shallExecuteTask +shallUpdateTaskFunctionWorkerUsage +start +taskStealingOnEmptyQueue tasksQueueSize +tasksStealingOnBackPressure +unsetTaskStealing +unsetTasksStealingOnBackPressure updateEluWorkerUsage updateRunTimeWorkerUsage updateTaskStatisticsWorkerUsage +updateTaskStolenStatisticsWorkerUsage updateWaitTimeWorkerUsage workerListener

    Constructors

    - +
    +
  • Defined in src/pools/abstract-pool.ts:126
  • Properties

    - -
    emitter?: PoolEmitter
    -

    Emitter on which events can be listened to.

    + +
    emitter?: __module | EventEmitterAsyncResource
    +

    Event emitter integrated with async resource on which events can be listened to. +The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

      -
    • 'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
    • 'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
    • -
    • 'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.
    • +
    • '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.
    • +
    • '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).
    +
  • Defined in src/pools/abstract-pool.ts:73
  • filePath: string
    @@ -207,7 +232,15 @@
    +
  • Defined in src/pools/abstract-pool.ts:128
  • +
    + +
    max?: number
    +

    Dynamic pool maximum size property placeholder.

    +
    +
    numberOfWorkers: number
    @@ -215,7 +248,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:127
  • opts: PoolOptions<Worker>
    @@ -223,11 +256,11 @@
    +
  • Defined in src/pools/abstract-pool.ts:129
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    -

    The task execution response promise map.

    +

    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.
    • @@ -236,7 +269,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:82
  • startTimestamp: number
    @@ -244,23 +277,35 @@
    +
  • Defined in src/pools/abstract-pool.ts:117
  • +
    + +
    started: boolean
    +

    Whether the pool is started or not.

    +
    +
    - +
    starting: boolean

    Whether the pool is starting or not.

    +
  • Defined in src/pools/abstract-pool.ts:113
  • - -
    taskFunctions: string[]
    -

    The task function names.

    + +
    taskFunctions: Map<string, TaskFunction<Data, Response>>
    +

    The task functions added at runtime map:

    +
      +
    • key: The task function name.
    • +
    • value: The task function itself.
    • +
    +
  • Defined in src/pools/abstract-pool.ts:104
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -268,16 +313,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:88
  • - +
    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

    +
  • Defined in src/pools/abstract-pool.ts:70
  • Accessors

    @@ -291,7 +336,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:660
  • +
  • Defined in src/pools/abstract-pool.ts:651
  • +
  • Defined in src/pools/abstract-pool.ts:271
  • - +
    +
  • Defined in src/pools/abstract-pool.ts:484
  • - +
    +
  • Defined in src/pools/abstract-pool.ts:477
  • +
  • Defined in src/pools/abstract-pool.ts:429
  • +
  • Defined in src/pools/abstract-pool.ts:467
  • +
  • Defined in src/pools/abstract-pool.ts:446
  • +
  • Defined in src/pools/abstract-pool.ts:472
  • Methods

    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1596
  • +
  • Defined in src/pools/abstract-pool.ts:1035
  • +
  • Defined in src/pools/abstract-pool.ts:1346
  • +
  • Defined in src/pools/abstract-pool.ts:1005
  • Returns TasksQueueOptions

    -
    - +
  • Defined in src/pools/abstract-pool.ts:600
  • +
    +
    -
    - -
    +
    + +
    -
    - +
  • Defined in src/pools/abstract-pool.ts:1559
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:1565
  • +
  • Defined in src/pools/abstract-pool.ts:494
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:170
  • Returns void

    -
    - -
    -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:188
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:217
  • +
  • Defined in src/pools/abstract-pool.ts:1162
  • +
  • Defined in src/pools/abstract-pool.ts:1252
  • +
  • Defined in src/pools/abstract-pool.ts:1208
  • +
  • Defined in src/pools/abstract-pool.ts:1201
  • +
    + +

    Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1661
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:940
  • +
  • Defined in src/pools/abstract-pool.ts:981
  • +
  • Defined in src/pools/abstract-pool.ts:565
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1655
  • +
  • Defined in src/pools/abstract-pool.ts:870
  • +
  • Defined in src/pools/abstract-pool.ts:1649
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1669
  • +
  • Defined in src/pools/abstract-pool.ts:1679
  • +
  • Defined in src/pools/abstract-pool.ts:1585
  • +
  • Defined in src/pools/abstract-pool.ts:513
  • +
  • Defined in src/pools/abstract-pool.ts:525
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1531
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1515
  • +
    + +
    +
    + +
    +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:667
  • -
    - +
  • Defined in src/pools/abstract-pool.ts:996
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:835
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1389
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1307
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1618
  • Returns Promise<void>

    +
  • Defined in src/pools/abstract-pool.ts:953
  • +
  • Defined in src/pools/abstract-pool.ts:1370
  • +
  • Defined in src/pools/abstract-pool.ts:1377
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1190
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:579
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:532
  • +
  • Defined in src/pools/abstract-pool.ts:551
  • +
  • Defined in src/pools/abstract-pool.ts:989
  • -
    - +
  • Defined in src/pools/abstract-pool.ts:1179
  • +
    + +
    +
    +
    +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1429
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1665
  • +
    + +
    +
    + +
    +
    + +

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1122
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1095
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1077
  • +
    + +

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1109
  • +
  • Defined in src/pools/abstract-pool.ts:1497
  • @@ -1317,10 +1697,12 @@ Can be overridden.

  • constructor
  • emitter
  • filePath
  • +
  • max
  • numberOfWorkers
  • opts
  • promiseResponseMap
  • startTimestamp
  • +
  • started
  • starting
  • taskFunctions
  • workerChoiceStrategyContext
  • @@ -1334,25 +1716,26 @@ Can be overridden.

  • type
  • utilization
  • worker
  • +
  • addTaskFunction
  • addWorkerNode
  • afterTaskExecutionHook
  • afterWorkerNodeSetup
  • beforeTaskExecutionHook
  • buildTasksQueueOptions
  • -
  • checkAndEmitEvents
  • -
  • checkDynamicPoolSize
  • -
  • checkFilePath
  • +
  • checkAndEmitDynamicWorkerCreationEvents
  • +
  • checkAndEmitTaskExecutionEvents
  • +
  • checkAndEmitTaskQueuingEvents
  • checkMessageWorkerId
  • checkNumberOfWorkers
  • checkPoolOptions
  • -
  • checkValidTasksQueueOptions
  • -
  • checkValidWorkerChoiceStrategy
  • checkValidWorkerChoiceStrategyOptions
  • chooseWorkerNode
  • createAndSetupDynamicWorkerNode
  • createAndSetupWorkerNode
  • createWorker
  • +
  • deleteTaskFunctionWorkerUsages
  • dequeueTask
  • +
  • deregisterWorkerMessageListener
  • destroy
  • destroyWorkerNode
  • enableTasksQueue
  • @@ -1366,90 +1749,72 @@ Can be overridden.

  • getWorkerNodeKeyByWorkerId
  • handleTaskExecutionResponse
  • handleWorkerReadyResponse
  • +
  • hasBackPressure
  • +
  • hasTaskFunction
  • +
  • hasWorkerNodeBackPressure
  • +
  • initializeEventEmitter
  • internalBusy
  • isMain
  • -
  • listTaskFunctions
  • +
  • listTaskFunctionNames
  • redistributeQueuedTasks
  • +
  • registerOnceWorkerMessageListener
  • registerWorkerMessageListener
  • +
  • removeTaskFunction
  • removeWorkerNode
  • sendKillMessageToWorker
  • sendStartupMessageToWorker
  • sendStatisticsMessageToWorker
  • +
  • sendTaskFunctionOperationToWorker
  • +
  • sendTaskFunctionOperationToWorkers
  • sendToWorker
  • +
  • setDefaultTaskFunction
  • +
  • setTaskStealing
  • setTasksQueueOptions
  • +
  • setTasksQueueSize
  • +
  • setTasksStealingOnBackPressure
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
  • setupHook
  • shallCreateDynamicWorker
  • -
  • startPool
  • +
  • shallExecuteTask
  • +
  • shallUpdateTaskFunctionWorkerUsage
  • +
  • start
  • +
  • taskStealingOnEmptyQueue
  • tasksQueueSize
  • +
  • tasksStealingOnBackPressure
  • +
  • unsetTaskStealing
  • +
  • unsetTasksStealingOnBackPressure
  • updateEluWorkerUsage
  • updateRunTimeWorkerUsage
  • updateTaskStatisticsWorkerUsage
  • +
  • updateTaskStolenStatisticsWorkerUsage
  • updateWaitTimeWorkerUsage
  • workerListener
  • +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file