X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=30969c24eba5305e5ab3a9f7431500638caca2a7;hb=5ee29ca61ee790da371ad3a83fc7b9c79fb02de2;hp=2fe2f7cd195f2bbd6499945eb63d4dad225ffc0c;hpb=0676e5d32c8f8ee5c5b7f5998f4973b0a276460f;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 2fe2f7cd..30969c24 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,13 +1,13 @@ -AbstractPool | poolifier - v2.6.30
+AbstractPool | poolifier - v2.7.0
-
+
  • The search index is not available
  • poolifier - v2.7.0 +
    @@ -49,32 +49,34 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:60
  • - +

    Constructors

    -

    Properties

    -

    Accessors

    -
    busy +
    busy full info maxSize @@ -86,7 +88,8 @@

    Methods

    -

    Constructors

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

    @@ -195,18 +213,18 @@

    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.
    • -
    • '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.
    • +
    • '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 >= pool maximum size^2).
    • +
    • '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:69
  • filePath: string
    @@ -214,7 +232,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:124
  • max?: number
    @@ -222,7 +240,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:93
  • numberOfWorkers: number
    @@ -230,7 +248,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:123
  • opts: PoolOptions<Worker>
    @@ -238,11 +256,11 @@
    +
  • Defined in src/pools/abstract-pool.ts:125
  • 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.
    • @@ -251,7 +269,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:78
  • startTimestamp: number
    @@ -259,15 +277,35 @@
    +
  • Defined in src/pools/abstract-pool.ts:113
  • +
    + +
    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:109
  • +
    + +
    taskFunctions: Map<string, TaskFunction<Data, Response>>
    +

    The task functions added at runtime map:

    + +
    +
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -275,7 +313,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:84
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -284,7 +322,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:66
  • Accessors

    @@ -298,7 +336,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:741
  • +
  • Defined in src/pools/abstract-pool.ts:732
  • +
  • Defined in src/pools/abstract-pool.ts:352
  • +
  • Defined in src/pools/abstract-pool.ts:565
  • +
  • Defined in src/pools/abstract-pool.ts:558
  • +
  • Defined in src/pools/abstract-pool.ts:510
  • +
  • Defined in src/pools/abstract-pool.ts:548
  • +
  • Defined in src/pools/abstract-pool.ts:527
  • +
  • Defined in src/pools/abstract-pool.ts:553
  • Methods

    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1624
  • +
  • Defined in src/pools/abstract-pool.ts:1090
  • +
  • Defined in src/pools/abstract-pool.ts:1374
  • +
  • Defined in src/pools/abstract-pool.ts:1060
  • Returns TasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:681
  • +
  • Defined in src/pools/abstract-pool.ts:1599
  • +
  • Defined in src/pools/abstract-pool.ts:1587
  • +
  • Defined in src/pools/abstract-pool.ts:1593
  • Returns void

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

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

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:267
  • +
  • Defined in src/pools/abstract-pool.ts:1217
  • +
  • Defined in src/pools/abstract-pool.ts:1307
  • +
  • Defined in src/pools/abstract-pool.ts:1263
  • +
  • Defined in src/pools/abstract-pool.ts:1256
  • +
    + +

    Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1689
  • +
  • Defined in src/pools/abstract-pool.ts:1000
  • +
  • Defined in src/pools/abstract-pool.ts:1036
  • +
  • Defined in src/pools/abstract-pool.ts:646
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1683
  • +
  • Defined in src/pools/abstract-pool.ts:930
  • +
  • Defined in src/pools/abstract-pool.ts:1677
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1697
  • +
  • Defined in src/pools/abstract-pool.ts:1707
  • +
  • Defined in src/pools/abstract-pool.ts:1613
  • +
  • Defined in src/pools/abstract-pool.ts:594
  • +
  • Defined in src/pools/abstract-pool.ts:606
  • Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:1543
  • +
  • Defined in src/pools/abstract-pool.ts:1662
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1655
  • +
  • Defined in src/pools/abstract-pool.ts:748
  • -
    - +
  • Defined in src/pools/abstract-pool.ts:1051
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:895
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1417
  • +
  • Defined in src/pools/abstract-pool.ts:1361
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1646
  • Returns Promise<void>

    +
  • Defined in src/pools/abstract-pool.ts:1010
  • +
  • Defined in src/pools/abstract-pool.ts:1398
  • +
  • Defined in src/pools/abstract-pool.ts:1405
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1245
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:660
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:613
  • +
  • Defined in src/pools/abstract-pool.ts:632
  • +
  • Defined in src/pools/abstract-pool.ts:1044
  • +
  • Defined in src/pools/abstract-pool.ts:1234
  • +
    + +
    -
    - +
  • Defined in src/pools/abstract-pool.ts:1123
  • +
    + +
    +
    +
    +
  • Defined in src/pools/abstract-pool.ts:1457
  • Returns number

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

    Returns void

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

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

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1164
  • +
  • Defined in src/pools/abstract-pool.ts:1525
  • @@ -1394,7 +1668,9 @@ Can be overridden.

  • opts
  • promiseResponseMap
  • startTimestamp
  • +
  • started
  • starting
  • +
  • taskFunctions
  • workerChoiceStrategyContext
  • workerNodes
  • busy
  • @@ -1406,6 +1682,7 @@ Can be overridden.

  • type
  • utilization
  • worker
  • +
  • addTaskFunction
  • addWorkerNode
  • afterTaskExecutionHook
  • afterWorkerNodeSetup
  • @@ -1426,6 +1703,7 @@ Can be overridden.

  • createAndSetupDynamicWorkerNode
  • createAndSetupWorkerNode
  • createWorker
  • +
  • deleteTaskFunctionWorkerUsages
  • dequeueTask
  • destroy
  • destroyWorkerNode
  • @@ -1441,93 +1719,69 @@ Can be overridden.

  • handleTaskExecutionResponse
  • handleWorkerReadyResponse
  • hasBackPressure
  • +
  • hasTaskFunction
  • hasWorkerNodeBackPressure
  • internalBusy
  • isMain
  • -
  • listTaskFunctions
  • +
  • listTaskFunctionNames
  • redistributeQueuedTasks
  • registerWorkerMessageListener
  • +
  • removeTaskFunction
  • removeWorkerNode
  • sendKillMessageToWorker
  • sendStartupMessageToWorker
  • sendStatisticsMessageToWorker
  • +
  • sendTaskFunctionOperationToWorker
  • +
  • sendTaskFunctionOperationToWorkers
  • sendToWorker
  • +
  • setDefaultTaskFunction
  • +
  • setTaskStealing
  • setTasksQueueOptions
  • +
  • setTasksQueueSize
  • +
  • setTasksStealingOnBackPressure
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
  • setupHook
  • shallCreateDynamicWorker
  • +
  • shallExecuteTask
  • shallUpdateTaskFunctionWorkerUsage
  • -
  • startPool
  • +
  • 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