X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=e382e9e16e85fa1b4736e8df9cfd0842e9c02057;hb=3eed67feea0f527e3ee31a6ebb1063883eec3855;hp=48d436c8a7e1ce36227e088badf7c1e00fb46e9f;hpb=019581cc38fe0b47645d9b2120f325ab37388be2;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 48d436c8..e382e9e1 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,13 +1,13 @@ -AbstractPool | poolifier - v2.6.28
+AbstractPool | poolifier - v2.6.45
-
+
  • The search index is not available
  • poolifier - v2.6.45 +
    @@ -49,32 +49,33 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:59
  • - +

    Constructors

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

    @@ -190,17 +205,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 >= maximum queue size).
    +
  • Defined in src/pools/abstract-pool.ts:68
  • filePath: string
    @@ -208,7 +224,15 @@
    +
  • Defined in src/pools/abstract-pool.ts:116
  • +
    + +
    max?: number
    +

    Dynamic pool maximum size property placeholder.

    +
    +
    numberOfWorkers: number
    @@ -216,7 +240,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:115
  • opts: PoolOptions<Worker>
    @@ -224,11 +248,11 @@
    +
  • Defined in src/pools/abstract-pool.ts:117
  • 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.
    • @@ -237,7 +261,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:77
  • startTimestamp: number
    @@ -245,23 +269,23 @@
    -
    - -
    starting: boolean
    -

    Whether the pool is starting or not.

    +
  • Defined in src/pools/abstract-pool.ts:105
  • +
    + +
    started: boolean
    +

    Whether the pool is started or not.

    -
    - -
    taskFunctions: string[]
    -

    The task function names.

    +
  • Defined in src/pools/abstract-pool.ts:97
  • +
    + +
    starting: boolean
    +

    Whether the pool is starting or not.

    +
  • Defined in src/pools/abstract-pool.ts:101
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -269,16 +293,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:83
  • - +
    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

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

    @@ -292,7 +316,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:731
  • +
  • Defined in src/pools/abstract-pool.ts:722
  • +
  • Defined in src/pools/abstract-pool.ts:342
  • - +
    +
  • Defined in src/pools/abstract-pool.ts:555
  • - +
    +
  • Defined in src/pools/abstract-pool.ts:548
  • +
  • Defined in src/pools/abstract-pool.ts:500
  • +
  • Defined in src/pools/abstract-pool.ts:538
  • +
  • Defined in src/pools/abstract-pool.ts:517
  • +
  • Defined in src/pools/abstract-pool.ts:543
  • Methods

    @@ -408,7 +432,7 @@

    Throws

    https://nodejs.org/api/errors.html#class-error If the added worker node is not found.

    +
  • Defined in src/pools/abstract-pool.ts:1469
  • +
  • Defined in src/pools/abstract-pool.ts:935
  • +
  • Defined in src/pools/abstract-pool.ts:1209
  • +
  • Defined in src/pools/abstract-pool.ts:905
  • Returns TasksQueueOptions

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

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

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

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:257
  • +
  • Defined in src/pools/abstract-pool.ts:1062
  • +
  • Defined in src/pools/abstract-pool.ts:1152
  • +
  • Defined in src/pools/abstract-pool.ts:1108
  • +
  • Defined in src/pools/abstract-pool.ts:1101
  • Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1534
  • +
  • Defined in src/pools/abstract-pool.ts:850
  • +
  • Defined in src/pools/abstract-pool.ts:881
  • +
  • Defined in src/pools/abstract-pool.ts:636
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1528
  • +
  • Defined in src/pools/abstract-pool.ts:779
  • +
  • Defined in src/pools/abstract-pool.ts:1522
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1542
  • +
  • Defined in src/pools/abstract-pool.ts:1552
  • +
  • Defined in src/pools/abstract-pool.ts:1458
  • +
  • Defined in src/pools/abstract-pool.ts:584
  • +
  • Defined in src/pools/abstract-pool.ts:596
  • Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:1390
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:738
  • +
  • Defined in src/pools/abstract-pool.ts:896
  • +
  • Defined in src/pools/abstract-pool.ts:758
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1253
  • +
  • Defined in src/pools/abstract-pool.ts:1196
  • +
  • Defined in src/pools/abstract-pool.ts:1491
  • Returns Promise<void>

    +
  • Defined in src/pools/abstract-pool.ts:860
  • +
  • Defined in src/pools/abstract-pool.ts:1233
  • +
  • Defined in src/pools/abstract-pool.ts:1240
  • +
  • Defined in src/pools/abstract-pool.ts:1090
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:650
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:603
  • +
  • Defined in src/pools/abstract-pool.ts:622
  • +
  • Defined in src/pools/abstract-pool.ts:889
  • -
    - +
  • Defined in src/pools/abstract-pool.ts:1079
  • +
    +
    +
    + +
    +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1297
  • Returns number

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

    Returns void

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

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

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1009
  • +
  • Defined in src/pools/abstract-pool.ts:1372
  • @@ -1318,12 +1510,13 @@ Can be overridden.

  • constructor
  • emitter
  • filePath
  • +
  • max
  • numberOfWorkers
  • opts
  • promiseResponseMap
  • startTimestamp
  • +
  • started
  • starting
  • -
  • taskFunctions
  • workerChoiceStrategyContext
  • workerNodes
  • busy
  • @@ -1340,7 +1533,9 @@ Can be overridden.

  • afterWorkerNodeSetup
  • beforeTaskExecutionHook
  • buildTasksQueueOptions
  • -
  • checkAndEmitEvents
  • +
  • checkAndEmitDynamicWorkerCreationEvents
  • +
  • checkAndEmitTaskExecutionEvents
  • +
  • checkAndEmitTaskQueuingEvents
  • checkDynamicPoolSize
  • checkFilePath
  • checkMessageWorkerId
  • @@ -1367,6 +1562,8 @@ Can be overridden.

  • getWorkerNodeKeyByWorkerId
  • handleTaskExecutionResponse
  • handleWorkerReadyResponse
  • +
  • hasBackPressure
  • +
  • hasWorkerNodeBackPressure
  • internalBusy
  • isMain
  • listTaskFunctions
  • @@ -1377,81 +1574,53 @@ Can be overridden.

  • sendStartupMessageToWorker
  • sendStatisticsMessageToWorker
  • sendToWorker
  • +
  • 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