X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=00d68b3d181866d60a64610ffe52a9cd7260643a;hb=969223ea18802a84dfea369e254332e11bf8e419;hp=8b279fef929856d2c4c298f1a55104b348cb44ad;hpb=ff6cf64964e78aafa95098852ec0472b567f7b1b;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 8b279fef..00d68b3d 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.6.26
+AbstractPool | poolifier - v2.6.33
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.26
+
  • The search index is not available
  • poolifier - v2.6.33
    @@ -49,7 +49,7 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:57
  • @@ -63,12 +63,13 @@

    Properties

    @@ -91,7 +92,9 @@ afterWorkerNodeSetup beforeTaskExecutionHook buildTasksQueueOptions -checkAndEmitEvents +checkAndEmitDynamicWorkerCreationEvents +checkAndEmitTaskExecutionEvents +checkAndEmitTaskQueuingEvents checkDynamicPoolSize checkFilePath checkMessageWorkerId @@ -118,6 +121,8 @@ getWorkerNodeKeyByWorkerId handleTaskExecutionResponse handleWorkerReadyResponse +hasBackPressure +hasWorkerNodeBackPressure internalBusy isMain listTaskFunctions @@ -128,13 +133,17 @@ sendStartupMessageToWorker sendStatisticsMessageToWorker sendToWorker +setTasksQueueMaxSize setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions setupHook shallCreateDynamicWorker +shallUpdateTaskFunctionWorkerUsage startPool +taskStealingOnEmptyQueue tasksQueueSize +tasksStealingOnBackPressure updateEluWorkerUsage updateRunTimeWorkerUsage updateTaskStatisticsWorkerUsage @@ -180,7 +189,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    @@ -189,17 +198,19 @@

    Emitter on which events can be listened to.

    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.
    • +
    • '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:66
  • filePath: string
    @@ -207,7 +218,15 @@
    +
  • Defined in src/pools/abstract-pool.ts:115
  • +
    + +
    max?: number
    +

    Dynamic pool maximum size property placeholder.

    +
    +
    numberOfWorkers: number
    @@ -215,7 +234,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:114
  • opts: PoolOptions<Worker>
    @@ -223,7 +242,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:116
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -236,7 +255,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:76
  • startTimestamp: number
    @@ -244,7 +263,15 @@
    +
  • Defined in src/pools/abstract-pool.ts:104
  • +
    + +
    started: boolean
    +

    Whether the pool is started or not.

    +
    +
    starting: boolean
    @@ -252,15 +279,7 @@
    -
    - -
    taskFunctions: string[]
    -

    The task function names.

    -
    -
    +
  • Defined in src/pools/abstract-pool.ts:96
  • workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -268,16 +287,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:82
  • - +
    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

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

    @@ -291,7 +310,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:691
  • +
  • Defined in src/pools/abstract-pool.ts:682
  • +
  • Defined in src/pools/abstract-pool.ts:354
  • - +
    +
  • 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

    @@ -407,7 +426,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:1401
  • +
  • Defined in src/pools/abstract-pool.ts:879
  • +
  • Defined in src/pools/abstract-pool.ts:1151
  • +
  • Defined in src/pools/abstract-pool.ts:849
  • Returns TasksQueueOptions

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

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

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

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:249
  • +
  • Defined in src/pools/abstract-pool.ts:1004
  • +
  • Defined in src/pools/abstract-pool.ts:1094
  • +
  • Defined in src/pools/abstract-pool.ts:1050
  • +
  • Defined in src/pools/abstract-pool.ts:1043
  • Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1467
  • +
  • Defined in src/pools/abstract-pool.ts:794
  • +
  • Defined in src/pools/abstract-pool.ts:825
  • +
  • Defined in src/pools/abstract-pool.ts:636
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1461
  • +
  • Defined in src/pools/abstract-pool.ts:732
  • +
  • Defined in src/pools/abstract-pool.ts:1455
  • Returns void

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

    Returns WorkerInfo

    The worker information.

    +

    Returns undefined | WorkerInfo

    The worker information.

    +
  • Defined in src/pools/abstract-pool.ts:1390
  • +
  • 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:1336
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1322
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:698
  • +
  • Defined in src/pools/abstract-pool.ts:840
  • +
  • Defined in src/pools/abstract-pool.ts:719
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1191
  • +
  • Defined in src/pools/abstract-pool.ts:1138
  • +
  • Defined in src/pools/abstract-pool.ts:1424
  • Returns Promise<void>

    +
  • Defined in src/pools/abstract-pool.ts:804
  • +
  • Defined in src/pools/abstract-pool.ts:1171
  • +
  • Defined in src/pools/abstract-pool.ts:1178
  • +
  • Defined in src/pools/abstract-pool.ts:1032
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:648
  • +
  • Defined in src/pools/abstract-pool.ts:603
  • +
  • Defined in src/pools/abstract-pool.ts:622
  • +
  • Defined in src/pools/abstract-pool.ts:833
  • +
  • Defined in src/pools/abstract-pool.ts:1021
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:341
  • +
    + +

    Returns number

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

    Returns void

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

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

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

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