X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=4f501d6f503d1bdab4b5ab50ca3e7d2d989f409e;hb=0cf6d1374ad842cc31aca1a8ddaa1bc5a9b9302b;hp=0ca50a44ae79957f264f28d6677463e9ffcc45fe;hpb=cb4889b43e6935f6dd70d8011ba085c9ca7218ba;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 0ca50a44..4f501d6f 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.6.41
+AbstractPool | poolifier - v3.0.4
  • Preparing search index...
  • -
  • The search index is not available
poolifier - v2.6.41
+
  • The search index is not available
  • poolifier - v3.0.4
    @@ -87,7 +88,8 @@

    Methods

    -
    addWorkerNode +
    addTaskFunction +addWorkerNode afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook @@ -95,62 +97,72 @@ checkAndEmitDynamicWorkerCreationEvents checkAndEmitTaskExecutionEvents checkAndEmitTaskQueuingEvents -checkDynamicPoolSize -checkFilePath checkMessageWorkerId checkNumberOfWorkers checkPoolOptions -checkValidTasksQueueOptions -checkValidWorkerChoiceStrategy checkValidWorkerChoiceStrategyOptions chooseWorkerNode createAndSetupDynamicWorkerNode createAndSetupWorkerNode createWorker +deleteTaskFunctionWorkerUsages dequeueTask +deregisterWorkerMessageListener destroy destroyWorkerNode enableTasksQueue enqueueTask execute executeTask +flagWorkerNodeAsNotReady flushTasksQueue flushTasksQueues getWorkerInfo getWorkerNodeKeyByWorker getWorkerNodeKeyByWorkerId +handleBackPressureEvent +handleEmptyQueueEvent 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 -taskStealingOnEmptyQueue +start tasksQueueSize -tasksStealingOnBackPressure +unsetTaskStealing +unsetTasksStealingOnBackPressure updateEluWorkerUsage updateRunTimeWorkerUsage updateTaskStatisticsWorkerUsage updateTaskStolenStatisticsWorkerUsage updateWaitTimeWorkerUsage -workerListener +workerMessageListener

    Constructors

    @@ -191,13 +203,14 @@

    Returns AbstractPool<Worker, Data, Response>

    +
  • Defined in src/pools/abstract-pool.ts:127
  • 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 +225,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:74
  • filePath: string
    @@ -220,7 +233,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:129
  • max?: number
    @@ -228,7 +241,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:79
  • numberOfWorkers: number
    @@ -236,7 +249,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:128
  • opts: PoolOptions<Worker>
    @@ -244,11 +257,11 @@
    +
  • Defined in src/pools/abstract-pool.ts:130
  • 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 +270,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:88
  • startTimestamp: number
    @@ -265,7 +278,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:118
  • started: boolean
    @@ -273,15 +286,27 @@
    +
  • Defined in src/pools/abstract-pool.ts:110
  • - +
    starting: boolean

    Whether the pool is starting or not.

    +
  • Defined in src/pools/abstract-pool.ts:114
  • +
    + +
    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 +314,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:94
  • workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -298,7 +323,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:71
  • Accessors

    @@ -312,7 +337,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:668
  • +
  • Defined in src/pools/abstract-pool.ts:659
  • +
  • Defined in src/pools/abstract-pool.ts:272
  • +
  • Defined in src/pools/abstract-pool.ts:485
  • +
  • Defined in src/pools/abstract-pool.ts:478
  • +
  • Defined in src/pools/abstract-pool.ts:430
  • +
  • Defined in src/pools/abstract-pool.ts:468
  • +
  • Defined in src/pools/abstract-pool.ts:447
  • +
  • Defined in src/pools/abstract-pool.ts:473
  • Methods

    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1613
  • +
  • Defined in src/pools/abstract-pool.ts:1041
  • +
  • Defined in src/pools/abstract-pool.ts:1354
  • +
  • Defined in src/pools/abstract-pool.ts:1011
  • Returns TasksQueueOptions

    +
  • Defined in src/pools/abstract-pool.ts:598
  • +
  • Defined in src/pools/abstract-pool.ts:1588
  • +
  • Defined in src/pools/abstract-pool.ts:1576
  • -
    - -
    -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:1582
  • +
  • Defined in src/pools/abstract-pool.ts:495
  • Returns void

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

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

    +
  • Defined in src/pools/abstract-pool.ts:218
  • +
  • Defined in src/pools/abstract-pool.ts:1168
  • +
  • Defined in src/pools/abstract-pool.ts:1258
  • +
  • Defined in src/pools/abstract-pool.ts:1214
  • +
  • Defined in src/pools/abstract-pool.ts:1207
  • +
    + +

    Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:1682
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:948
  • +
  • Defined in src/pools/abstract-pool.ts:987
  • +
  • Defined in src/pools/abstract-pool.ts:563
  • Returns number

    +
  • Defined in src/pools/abstract-pool.ts:1676
  • +
  • Defined in src/pools/abstract-pool.ts:878
  • +
  • Defined in src/pools/abstract-pool.ts:1670
  • +
    + +

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1690
  • +
  • Defined in src/pools/abstract-pool.ts:1700
  • +
  • Defined in src/pools/abstract-pool.ts:1602
  • +
  • Defined in src/pools/abstract-pool.ts:511
  • +
  • Defined in src/pools/abstract-pool.ts:523
  • +
    + +
    +
    + +

    Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:1532
  • +
  • Defined in src/pools/abstract-pool.ts:1655
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1648
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:675
  • -
    - +
  • Defined in src/pools/abstract-pool.ts:1002
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:843
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1404
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1315
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1635
  • Returns Promise<void>

    +
  • Defined in src/pools/abstract-pool.ts:959
  • +
  • Defined in src/pools/abstract-pool.ts:1385
  • +
  • Defined in src/pools/abstract-pool.ts:1392
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:1196
  • +
    + +
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:577
  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:612
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:530
  • +
  • Defined in src/pools/abstract-pool.ts:549
  • +
  • Defined in src/pools/abstract-pool.ts:995
  • +
  • Defined in src/pools/abstract-pool.ts:1185
  • Returns boolean

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

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

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

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

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

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

    -
    - +
  • Defined in src/pools/abstract-pool.ts:1115
  • +
    +
    +
  • Defined in src/pools/abstract-pool.ts:1516
  • @@ -1477,6 +1707,7 @@ Can be overridden.

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

  • type
  • utilization
  • worker
  • +
  • addTaskFunction
  • addWorkerNode
  • afterTaskExecutionHook
  • afterWorkerNodeSetup
  • @@ -1496,64 +1728,74 @@ Can be overridden.

  • checkAndEmitDynamicWorkerCreationEvents
  • checkAndEmitTaskExecutionEvents
  • checkAndEmitTaskQueuingEvents
  • -
  • checkDynamicPoolSize
  • -
  • checkFilePath
  • checkMessageWorkerId
  • checkNumberOfWorkers
  • checkPoolOptions
  • -
  • checkValidTasksQueueOptions
  • -
  • checkValidWorkerChoiceStrategy
  • checkValidWorkerChoiceStrategyOptions
  • chooseWorkerNode
  • createAndSetupDynamicWorkerNode
  • createAndSetupWorkerNode
  • createWorker
  • +
  • deleteTaskFunctionWorkerUsages
  • dequeueTask
  • +
  • deregisterWorkerMessageListener
  • destroy
  • destroyWorkerNode
  • enableTasksQueue
  • enqueueTask
  • execute
  • executeTask
  • +
  • flagWorkerNodeAsNotReady
  • flushTasksQueue
  • flushTasksQueues
  • getWorkerInfo
  • getWorkerNodeKeyByWorker
  • getWorkerNodeKeyByWorkerId
  • +
  • handleBackPressureEvent
  • +
  • handleEmptyQueueEvent
  • 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
  • -
  • taskStealingOnEmptyQueue
  • +
  • start
  • 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