X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=aff9850dd46ceb55e6088a5de0ea9e4d8b744410;hb=31542ddfe8297d3bd0f9cf97a3de06a03dafc15d;hp=7f201407c20601a160864b3a7f517daafefb0211;hpb=a13e50c30dd0e0714ace0e1ea4ea1b36cdd18ab7;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 7f201407..aff9850d 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.6.27
+AbstractPool | poolifier - v2.6.32
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.27
+
  • The search index is not available
  • poolifier - v2.6.32
    @@ -49,7 +49,7 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:56
  • @@ -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,16 @@ sendStartupMessageToWorker sendStatisticsMessageToWorker sendToWorker +setTasksQueueMaxSize setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions setupHook shallCreateDynamicWorker +shallUpdateTaskFunctionWorkerUsage startPool tasksQueueSize +tasksStealingOnBackPressure updateEluWorkerUsage updateRunTimeWorkerUsage updateTaskStatisticsWorkerUsage @@ -180,7 +188,7 @@

    Returns AbstractPool<Worker, Data, Response>

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

    @@ -195,12 +203,13 @@
  • '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:65
  • filePath: string
    @@ -208,7 +217,15 @@
    +
  • Defined in src/pools/abstract-pool.ts:114
  • +
    + +
    max?: number
    +

    Dynamic pool maximum size property placeholder.

    +
    +
    numberOfWorkers: number
    @@ -216,7 +233,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:113
  • opts: PoolOptions<Worker>
    @@ -224,7 +241,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:115
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -237,7 +254,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:75
  • startTimestamp: number
    @@ -245,7 +262,15 @@
    +
  • Defined in src/pools/abstract-pool.ts:103
  • +
    + +
    started: boolean
    +

    Whether the pool is started or not.

    +
    +
    starting: boolean
    @@ -253,15 +278,7 @@
    -
    - -
    taskFunctions: string[]
    -

    The task function names.

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

    Pool worker nodes.

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

    @@ -292,7 +309,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:684
  • +
  • Defined in src/pools/abstract-pool.ts:675
  • +
  • Defined in src/pools/abstract-pool.ts:345
  • - +
    +
  • Defined in src/pools/abstract-pool.ts:546
  • - +
    +
  • Defined in src/pools/abstract-pool.ts:539
  • +
  • Defined in src/pools/abstract-pool.ts:491
  • +
  • Defined in src/pools/abstract-pool.ts:529
  • +
  • Defined in src/pools/abstract-pool.ts:508
  • +
  • Defined in src/pools/abstract-pool.ts:534
  • Methods

    @@ -408,7 +425,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:1360
  • +
  • Defined in src/pools/abstract-pool.ts:872
  • +
  • Defined in src/pools/abstract-pool.ts:1144
  • +
  • Defined in src/pools/abstract-pool.ts:842
  • Returns TasksQueueOptions

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

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

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

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:248
  • +
  • Defined in src/pools/abstract-pool.ts:997
  • +
  • Defined in src/pools/abstract-pool.ts:1087
  • +
  • Defined in src/pools/abstract-pool.ts:1043
  • +
  • Defined in src/pools/abstract-pool.ts:1036
  • Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1426
  • +
  • Defined in src/pools/abstract-pool.ts:787
  • +
  • Defined in src/pools/abstract-pool.ts:818
  • +
  • Defined in src/pools/abstract-pool.ts:627
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1420
  • +
  • Defined in src/pools/abstract-pool.ts:725
  • +
  • Defined in src/pools/abstract-pool.ts:1414
  • Returns void

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

    Returns WorkerInfo

    The worker information.

    +

    Returns undefined | WorkerInfo

    The worker information.

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

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

    +
  • Defined in src/pools/abstract-pool.ts:1281
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:691
  • +
  • Defined in src/pools/abstract-pool.ts:833
  • +
  • Defined in src/pools/abstract-pool.ts:712
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1182
  • +
  • Defined in src/pools/abstract-pool.ts:1131
  • +
  • Defined in src/pools/abstract-pool.ts:1383
  • Returns Promise<void>

    +
  • Defined in src/pools/abstract-pool.ts:797
  • +
  • Defined in src/pools/abstract-pool.ts:1162
  • +
  • Defined in src/pools/abstract-pool.ts:1169
  • +
  • Defined in src/pools/abstract-pool.ts:1025
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:639
  • +
  • Defined in src/pools/abstract-pool.ts:594
  • +
  • Defined in src/pools/abstract-pool.ts:613
  • +
  • Defined in src/pools/abstract-pool.ts:826
  • +
  • Defined in src/pools/abstract-pool.ts:1014
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:332
  • Returns number

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

    Returns void

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

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

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

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