X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=86fada26adb28db38824ca5ecf87c2b5d236b18c;hb=ef29303558d4caf5ff412db9579ea28346b77f3f;hp=be753f26c66d6837b8e47043f8cb866625b74dfd;hpb=4445abb25ec4c9d80985ca93c65762a6c892a852;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index be753f26..86fada26 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,13 +1,13 @@ -AbstractPool | poolifier - v2.6.31
+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

    @@ -195,18 +201,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:68
  • filePath: string
    @@ -214,7 +220,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:116
  • max?: number
    @@ -222,7 +228,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:92
  • numberOfWorkers: number
    @@ -230,7 +236,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:115
  • opts: PoolOptions<Worker>
    @@ -238,11 +244,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.
    • @@ -251,7 +257,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:77
  • startTimestamp: number
    @@ -259,15 +265,23 @@
    +
  • Defined in src/pools/abstract-pool.ts:105
  • +
    + +
    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:101
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -275,7 +289,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:83
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -284,7 +298,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:65
  • Accessors

    @@ -298,7 +312,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:685
  • +
  • Defined in src/pools/abstract-pool.ts:676
  • +
  • Defined in src/pools/abstract-pool.ts:334
  • +
  • Defined in src/pools/abstract-pool.ts:547
  • +
  • Defined in src/pools/abstract-pool.ts:540
  • +
  • Defined in src/pools/abstract-pool.ts:492
  • +
  • Defined in src/pools/abstract-pool.ts:530
  • +
  • Defined in src/pools/abstract-pool.ts:509
  • +
  • Defined in src/pools/abstract-pool.ts:535
  • Methods

    @@ -414,7 +428,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:1423
  • +
  • Defined in src/pools/abstract-pool.ts:889
  • +
  • Defined in src/pools/abstract-pool.ts:1163
  • +
  • Defined in src/pools/abstract-pool.ts:859
  • Returns TasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:657
  • +
  • Defined in src/pools/abstract-pool.ts:1398
  • +
  • Defined in src/pools/abstract-pool.ts:1386
  • +
  • Defined in src/pools/abstract-pool.ts:1392
  • 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:557
  • 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:296
  • Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:252
  • +
  • Defined in src/pools/abstract-pool.ts:1016
  • +
  • Defined in src/pools/abstract-pool.ts:1106
  • +
  • Defined in src/pools/abstract-pool.ts:1062
  • +
  • Defined in src/pools/abstract-pool.ts:1055
  • Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1488
  • +
  • Defined in src/pools/abstract-pool.ts:804
  • +
  • Defined in src/pools/abstract-pool.ts:835
  • +
  • Defined in src/pools/abstract-pool.ts:628
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1482
  • +
  • Defined in src/pools/abstract-pool.ts:733
  • +
  • Defined in src/pools/abstract-pool.ts:1476
  • Returns void

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

    Returns undefined | WorkerInfo

    The worker information.

    +

    Returns WorkerInfo

    The worker information.

    +
  • Defined in src/pools/abstract-pool.ts:1412
  • +
  • Defined in src/pools/abstract-pool.ts:576
  • +
  • Defined in src/pools/abstract-pool.ts:588
  • Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:1344
  • +
  • Defined in src/pools/abstract-pool.ts:1461
  • +
  • Defined in src/pools/abstract-pool.ts:1454
  • +
  • Defined in src/pools/abstract-pool.ts:692
  • +
  • Defined in src/pools/abstract-pool.ts:850
  • +
  • Defined in src/pools/abstract-pool.ts:712
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1207
  • +
  • Defined in src/pools/abstract-pool.ts:1150
  • +
  • Defined in src/pools/abstract-pool.ts:1445
  • Returns Promise<void>

    +
  • Defined in src/pools/abstract-pool.ts:814
  • +
  • Defined in src/pools/abstract-pool.ts:1187
  • +
  • Defined in src/pools/abstract-pool.ts:1194
  • +
  • Defined in src/pools/abstract-pool.ts:1044
  • +
  • Defined in src/pools/abstract-pool.ts:640
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:595
  • +
  • Defined in src/pools/abstract-pool.ts:614
  • +
  • Defined in src/pools/abstract-pool.ts:843
  • +
  • Defined in src/pools/abstract-pool.ts:1033
  • +
    + +
    -
    - +
  • Defined in src/pools/abstract-pool.ts:922
  • +
    + +
    +
    +
    +
  • Defined in src/pools/abstract-pool.ts:1251
  • Returns number

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

    Returns void

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

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

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

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:963
  • +
  • Defined in src/pools/abstract-pool.ts:1326
  • @@ -1394,6 +1479,7 @@ Can be overridden.

  • opts
  • promiseResponseMap
  • startTimestamp
  • +
  • started
  • starting
  • workerChoiceStrategyContext
  • workerNodes
  • @@ -1453,81 +1539,48 @@ Can be overridden.

  • sendStatisticsMessageToWorker
  • sendToWorker
  • setTasksQueueOptions
  • +
  • setTasksQueueSize
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
  • setupHook
  • shallCreateDynamicWorker
  • +
  • shallExecuteTask
  • shallUpdateTaskFunctionWorkerUsage
  • -
  • startPool
  • +
  • start
  • +
  • taskStealingOnEmptyQueue
  • tasksQueueSize
  • +
  • tasksStealingOnBackPressure
  • updateEluWorkerUsage
  • updateRunTimeWorkerUsage
  • updateTaskStatisticsWorkerUsage
  • +
  • updateTaskStolenStatisticsWorkerUsage
  • updateWaitTimeWorkerUsage
  • workerListener
  • +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file