X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=57b75a1a6da1adfb6f25fa46a5518a8e1ce7ed62;hb=70ceef6e16bec1f1d12754b2f5e8d71c91ca06a7;hp=13d1951e8eaac2067433f45d10fb1b694d24a741;hpb=71d327d5587f0ce2b746ba33ec0cfbb3a0dc5d1b;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 13d1951e..57b75a1a 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,4 +1,4 @@ -AbstractPool | poolifier - v2.7.4
+AbstractPool | poolifier - v3.0.0
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.7.4
+
  • The search index is not available
    • poolifier - v3.0.0
    @@ -49,7 +49,7 @@
    • IPool<Worker, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:64
    • @@ -161,7 +161,7 @@ updateTaskStatisticsWorkerUsage updateTaskStolenStatisticsWorkerUsage updateWaitTimeWorkerUsage -workerListener +workerMessageListener

    Constructors

    @@ -202,12 +202,12 @@

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

    Optional emitter

    -
    emitter?: __module | EventEmitterAsyncResource
    +
    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:

    @@ -224,7 +224,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:73

    • Protected Readonly filePath

    filePath: string
    @@ -232,7 +232,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:128

    • Protected Optional Readonly max

    max?: number
    @@ -240,7 +240,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:78

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -248,7 +248,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:127

    • Protected Readonly opts

    opts: PoolOptions<Worker>
    @@ -256,7 +256,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:129

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -269,7 +269,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:87

    • Private Readonly startTimestamp

    startTimestamp: number
    @@ -277,7 +277,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:117

    • Private started

    started: boolean
    @@ -285,7 +285,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:109

    • Private starting

    starting: boolean
    @@ -293,7 +293,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:113

    • Private Readonly taskFunctions

    taskFunctions: Map<string, TaskFunction<Data, Response>>
    @@ -305,7 +305,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:104

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -313,7 +313,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:93

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -322,7 +322,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    +
  • Defined in src/pools/abstract-pool.ts:70

    • Accessors

    @@ -336,7 +336,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected Abstract type

      @@ -405,7 +405,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

      Returns "fixed" | "dynamic"

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

    • Private utilization

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

    • Protected Abstract worker

      @@ -428,7 +428,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

      Returns "thread" | "cluster"

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

    • Methods

    @@ -461,7 +461,7 @@ If a task function with the same name already exists, it will be overwritten.

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

    • Private addWorkerNode

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

    • Protected afterTaskExecutionHook

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

    • Protected afterWorkerNodeSetup

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

    • Protected beforeTaskExecutionHook

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitDynamicWorkerCreationEvents

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

    • Private checkAndEmitTaskExecutionEvents

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

    • Private checkAndEmitTaskQueuingEvents

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

    • Private checkMessageWorkerId

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

    • Private checkNumberOfWorkers

      @@ -624,7 +624,7 @@ Can be overridden.

      numberOfWorkers: number

    Returns void

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

    • Private checkPoolOptions

      @@ -637,7 +637,7 @@ Can be overridden.

      opts: PoolOptions<Worker>

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Private chooseWorkerNode

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected Abstract createWorker

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

    • Private deleteTaskFunctionWorkerUsages

      @@ -712,7 +712,7 @@ Can be overridden.

      name: string

    Returns void

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

    • Private dequeueTask

      @@ -725,7 +725,7 @@ Can be overridden.

      workerNodeKey: number

    Returns undefined | Task<Data>

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

    • Protected Abstract deregisterWorkerMessageListener

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

    • destroy

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

    • Protected Abstract destroyWorkerNode

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

    • enableTasksQueue

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

    • Private enqueueTask

      @@ -836,7 +836,7 @@ Can be overridden.

      task: Task<Data>

    Returns number

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

    • execute

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

    • Private executeTask

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

    • Protected flushTasksQueue

      @@ -904,7 +904,7 @@ Can be overridden.

      workerNodeKey: number

    Returns void

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

    • Private flushTasksQueues

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

    • Protected getWorkerInfo

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

    • Private getWorkerNodeKeyByWorker

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

    • Private getWorkerNodeKeyByWorkerId

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

    • Private handleTaskExecutionResponse

      @@ -985,7 +985,7 @@ Can be overridden.

      message: MessageValue<Response, unknown>

    Returns void

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

    • Private handleWorkerReadyResponse

      @@ -998,7 +998,7 @@ Can be overridden.

      message: MessageValue<Response, unknown>

    Returns void

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

    • Private hasBackPressure

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

    • hasTaskFunction

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

    • hasWorkerNodeBackPressure

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

    • Private initializeEventEmitter

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • listTaskFunctionNames

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

    • Private redistributeQueuedTasks

      @@ -1105,7 +1105,7 @@ Can be overridden.

      workerNodeKey: number

    Returns void

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

    • Protected Abstract registerOnceWorkerMessageListener

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

    • Protected Abstract registerWorkerMessageListener

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

    • removeTaskFunction

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

    • Private removeWorkerNode

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

    • Protected sendKillMessageToWorker

      @@ -1238,7 +1238,7 @@ Can be overridden.

      workerNodeKey: number

    Returns Promise<void>

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

    • Protected Abstract sendStartupMessageToWorker

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

    • Private sendStatisticsMessageToWorker

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

    • Private sendTaskFunctionOperationToWorker

      @@ -1291,7 +1291,7 @@ Can be overridden.

      message: MessageValue<Data, unknown>

    Returns Promise<boolean>

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

    • Private sendTaskFunctionOperationToWorkers

      @@ -1304,7 +1304,7 @@ Can be overridden.

      message: MessageValue<Data, unknown>

    Returns Promise<boolean>

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

    • Protected Abstract sendToWorker

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

    • setDefaultTaskFunction

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

    • Private setTaskStealing

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

    • setTasksQueueOptions

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

    • Private setTasksQueueSize

      @@ -1395,7 +1395,7 @@ Can be overridden.

      size: number

    Returns void

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

    • Private setTasksStealingOnBackPressure

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

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

    • Private shallCreateDynamicWorker

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

    • Private shallExecuteTask

      @@ -1485,7 +1485,7 @@ Can be overridden.

      workerNodeKey: number

    Returns boolean

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

    • Private shallUpdateTaskFunctionWorkerUsage

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

    • start

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

    • Private taskStealingOnEmptyQueue

      @@ -1530,7 +1530,7 @@ Can be overridden.

      workerId: number

    Returns void

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

    • Private tasksQueueSize

      @@ -1543,7 +1543,7 @@ Can be overridden.

      workerNodeKey: number

    Returns number

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

    • Private tasksStealingOnBackPressure

      @@ -1556,7 +1556,7 @@ Can be overridden.

      workerId: number

    Returns void

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

    • Private unsetTaskStealing

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

    • Private unsetTasksStealingOnBackPressure

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

    • Private updateEluWorkerUsage

      @@ -1587,7 +1587,7 @@ Can be overridden.

      message: MessageValue<Response, unknown>

    Returns void

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

    • Private updateRunTimeWorkerUsage

      @@ -1602,7 +1602,7 @@ Can be overridden.

      message: MessageValue<Response, unknown>

    Returns void

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

    • Private updateTaskStatisticsWorkerUsage

      @@ -1617,7 +1617,7 @@ Can be overridden.

      message: MessageValue<Response, unknown>

    Returns void

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

    • Private updateTaskStolenStatisticsWorkerUsage

      @@ -1632,7 +1632,7 @@ Can be overridden.

      taskName: string

    Returns void

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

    • Private updateWaitTimeWorkerUsage

      @@ -1647,34 +1647,23 @@ Can be overridden.

      task: Task<Data>

    Returns void

    -
    -

    Protected workerListener

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

    Protected workerMessageListener

      - +
    • -

      This method is the listener registered for each worker message.

      -
      -

      Returns ((message) => void)

      The listener function to execute when a message is received from a worker.

      - -
        -
      • -
          -
        • (message): void
          • -
        • -

          This method is the listener registered for each worker message.

          +

          This method is the message listener registered on each worker.

          Parameters

          -

          Returns void

          The listener function to execute when a message is received from a worker.

          - -
      +

      Returns void

    +
  • Defined in src/pools/abstract-pool.ts:1496
    • @@ -1684,10 +1673,10 @@ Can be overridden.

    Member Visibility

      -
      • -
      • -
      • -
    +
    • +
    • +
    • +

    • Theme

    @@ -1789,9 +1778,9 @@ Can be overridden.

  • updateTaskStatisticsWorkerUsage
  • updateTaskStolenStatisticsWorkerUsage
  • updateWaitTimeWorkerUsage
    • -
  • workerListener
    • +
  • workerMessageListener
    • -

    Generated using TypeDoc

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