X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=57b75a1a6da1adfb6f25fa46a5518a8e1ce7ed62;hb=70ceef6e16bec1f1d12754b2f5e8d71c91ca06a7;hp=dec90f6fe56e23902d9003daa955bd2a224459db;hpb=7455be54c58f74c6f0d0dd597aa431a88da0a9d8;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index dec90f6f..57b75a1a 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.6.42
+AbstractPool | poolifier - v3.0.0
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.42
+
  • The search index is not available
  • poolifier - v3.0.0
    @@ -87,7 +88,8 @@

    Methods

    -
    addWorkerNode +
    addTaskFunction +addWorkerNode afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook @@ -95,19 +97,17 @@ checkAndEmitDynamicWorkerCreationEvents checkAndEmitTaskExecutionEvents checkAndEmitTaskQueuingEvents -checkDynamicPoolSize -checkFilePath checkMessageWorkerId checkNumberOfWorkers checkPoolOptions -checkValidTasksQueueOptions -checkValidWorkerChoiceStrategy checkValidWorkerChoiceStrategyOptions chooseWorkerNode createAndSetupDynamicWorkerNode createAndSetupWorkerNode createWorker +deleteTaskFunctionWorkerUsages dequeueTask +deregisterWorkerMessageListener destroy destroyWorkerNode enableTasksQueue @@ -122,35 +122,46 @@ handleTaskExecutionResponse handleWorkerReadyResponse hasBackPressure +hasTaskFunction hasWorkerNodeBackPressure +initializeEventEmitter internalBusy isMain -listTaskFunctions +listTaskFunctionNames redistributeQueuedTasks +registerOnceWorkerMessageListener 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 +workerMessageListener

    Constructors

    @@ -191,13 +202,14 @@

    Returns AbstractPool<Worker, Data, Response>

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

    - -
    emitter?: PoolEmitter
    -

    Emitter on which events can be listened to.

    + +
    emitter?: EventEmitterAsyncResource
    +

    Event emitter integrated with async resource on which events can be listened to. +The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    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.
    • @@ -212,7 +224,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:73
  • filePath: string
    @@ -220,7 +232,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:128
  • max?: number
    @@ -228,7 +240,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:78
  • numberOfWorkers: number
    @@ -236,7 +248,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:127
  • opts: PoolOptions<Worker>
    @@ -244,11 +256,11 @@
    +
  • Defined in src/pools/abstract-pool.ts:129
  • 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.
    • @@ -257,7 +269,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:87
  • startTimestamp: number
    @@ -265,7 +277,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:117
  • started: boolean
    @@ -273,15 +285,27 @@
    +
  • Defined in src/pools/abstract-pool.ts:109
  • - +
    starting: boolean

    Whether the pool is starting or not.

    +
  • Defined in src/pools/abstract-pool.ts:113
  • +
    + +
    taskFunctions: Map<string, TaskFunction<Data, Response>>
    +

    The task functions added at runtime map:

    +
      +
    • key: The task function name.
    • +
    • value: The task function itself.
    • +
    +
    +
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -289,7 +313,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:93
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -298,7 +322,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:70
  • Accessors

    @@ -312,7 +336,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:660
  • +
  • Defined in src/pools/abstract-pool.ts:651
  • +
  • Defined in src/pools/abstract-pool.ts:271
  • +
  • Defined in src/pools/abstract-pool.ts:484
  • +
  • Defined in src/pools/abstract-pool.ts:477
  • +
  • Defined in src/pools/abstract-pool.ts:429
  • +
  • Defined in src/pools/abstract-pool.ts:467
  • +
  • Defined in src/pools/abstract-pool.ts:446
  • +
  • Defined in src/pools/abstract-pool.ts:472
  • Methods

    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1593
  • +
  • Defined in src/pools/abstract-pool.ts:1033
  • +
  • Defined in src/pools/abstract-pool.ts:1344
  • +
  • Defined in src/pools/abstract-pool.ts:1003
  • Returns TasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:600
  • +
  • Defined in src/pools/abstract-pool.ts:1568
  • +
  • Defined in src/pools/abstract-pool.ts:1556
  • -
    - -
    -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:1562
  • +
  • Defined in src/pools/abstract-pool.ts:494
  • Returns void

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

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

    +
  • Defined in src/pools/abstract-pool.ts:217
  • +
  • Defined in src/pools/abstract-pool.ts:1160
  • +
  • Defined in src/pools/abstract-pool.ts:1250
  • +
  • Defined in src/pools/abstract-pool.ts:1206
  • +
  • Defined in src/pools/abstract-pool.ts:1199
  • +
    + +

    Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1658
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:940
  • +
  • Defined in src/pools/abstract-pool.ts:979
  • +
  • Defined in src/pools/abstract-pool.ts:565
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1652
  • +
  • Defined in src/pools/abstract-pool.ts:870
  • +
  • Defined in src/pools/abstract-pool.ts:1646
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1666
  • +
  • Defined in src/pools/abstract-pool.ts:1676
  • +
  • Defined in src/pools/abstract-pool.ts:1582
  • +
  • Defined in src/pools/abstract-pool.ts:513
  • +
  • Defined in src/pools/abstract-pool.ts:525
  • Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:1512
  • +
  • Defined in src/pools/abstract-pool.ts:1631
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1624
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:667
  • -
    - +
  • Defined in src/pools/abstract-pool.ts:994
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:835
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1390
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1305
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1615
  • Returns Promise<void>

    +
  • Defined in src/pools/abstract-pool.ts:951
  • +
  • Defined in src/pools/abstract-pool.ts:1371
  • +
  • Defined in src/pools/abstract-pool.ts:1378
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1188
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:579
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:614
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:532
  • +
  • Defined in src/pools/abstract-pool.ts:551
  • +
  • Defined in src/pools/abstract-pool.ts:987
  • +
  • Defined in src/pools/abstract-pool.ts:1177
  • Returns boolean

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

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

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

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

    Returns void

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

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

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

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

    -
    - +
  • Defined in src/pools/abstract-pool.ts:1107
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:1496
  • @@ -1477,6 +1693,7 @@ Can be overridden.

  • startTimestamp
  • started
  • starting
  • +
  • taskFunctions
  • workerChoiceStrategyContext
  • workerNodes
  • busy
  • @@ -1488,6 +1705,7 @@ Can be overridden.

  • type
  • utilization
  • worker
  • +
  • addTaskFunction
  • addWorkerNode
  • afterTaskExecutionHook
  • afterWorkerNodeSetup
  • @@ -1496,19 +1714,17 @@ Can be overridden.

  • checkAndEmitDynamicWorkerCreationEvents
  • checkAndEmitTaskExecutionEvents
  • checkAndEmitTaskQueuingEvents
  • -
  • checkDynamicPoolSize
  • -
  • checkFilePath
  • checkMessageWorkerId
  • checkNumberOfWorkers
  • checkPoolOptions
  • -
  • checkValidTasksQueueOptions
  • -
  • checkValidWorkerChoiceStrategy
  • checkValidWorkerChoiceStrategyOptions
  • chooseWorkerNode
  • createAndSetupDynamicWorkerNode
  • createAndSetupWorkerNode
  • createWorker
  • +
  • deleteTaskFunctionWorkerUsages
  • dequeueTask
  • +
  • deregisterWorkerMessageListener
  • destroy
  • destroyWorkerNode
  • enableTasksQueue
  • @@ -1523,37 +1739,48 @@ Can be overridden.

  • handleTaskExecutionResponse
  • handleWorkerReadyResponse
  • hasBackPressure
  • +
  • hasTaskFunction
  • hasWorkerNodeBackPressure
  • +
  • initializeEventEmitter
  • internalBusy
  • isMain
  • -
  • listTaskFunctions
  • +
  • listTaskFunctionNames
  • redistributeQueuedTasks
  • +
  • registerOnceWorkerMessageListener
  • 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
  • +
  • workerMessageListener
  • Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file