X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=0ca50a44ae79957f264f28d6677463e9ffcc45fe;hb=cb4889b43e6935f6dd70d8011ba085c9ca7218ba;hp=e2a2a08256775bd466e5b39bf6503bf8743de05c;hpb=c8284c4cf12c3aabc04aa0c382d1494eff8a2698;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index e2a2a082..0ca50a44 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,13 +1,13 @@ -AbstractPool | poolifier - v2.6.41
+AbstractPool | poolifier - v2.6.41
-
+
@@ -49,19 +49,19 @@
  • IPool<Worker, Data, Response>
+
  • Defined in src/pools/abstract-pool.ts:59
    • - +

    Constructors

    -
    constructor +
    constructor

    Properties

    -
    emitter? +
    emitter? filePath max? numberOfWorkers @@ -75,7 +75,7 @@

    Accessors

    -
    busy +
    busy full info maxSize @@ -87,7 +87,7 @@

    Methods

    -
    addWorkerNode +
    addWorkerNode afterTaskExecutionHook afterWorkerNodeSetup beforeTaskExecutionHook @@ -155,7 +155,7 @@

    Constructors

    -

    constructor

    +

    constructor

    • @@ -176,19 +176,22 @@
    • numberOfWorkers: number

      Number of workers that this pool should manage.

      -
      • +
    +
  • filePath: string

    Path to the worker file.

    -
    • +
    +
  • opts: PoolOptions<Worker>

    Options for the pool.

    -
    • +
    +

    Returns AbstractPool<Worker, Data, Response>

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

    • Properties

    @@ -209,7 +212,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:68

    • Protected Readonly filePath

    filePath: string
    @@ -217,7 +220,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:117

    • Protected Optional Readonly max

    max?: number
    @@ -225,7 +228,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:93

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -233,7 +236,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:116

    • Protected Readonly opts

    opts: PoolOptions<Worker>
    @@ -241,7 +244,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:118

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...
    @@ -254,7 +257,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:78

    • Private Readonly startTimestamp

    startTimestamp: number
    @@ -262,7 +265,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:106

    • Private started

    started: boolean
    @@ -270,7 +273,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:102

    • Private Readonly starting

    starting: boolean
    @@ -278,7 +281,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:98

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -286,7 +289,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:84

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []
    @@ -295,7 +298,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:65

    • Accessors

    @@ -309,7 +312,7 @@

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected Abstract type

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

    • Private utilization

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

    • Protected Abstract worker

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

    • Methods

    @@ -417,14 +420,15 @@
  • worker: Worker

    The worker.

    -
    • + +

    Returns number

    The added worker node key.

    Throws

    https://nodejs.org/api/errors.html#class-error If the added worker node is not found.

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

    • Protected afterTaskExecutionHook

    + +

    Returns void

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

    • Protected afterWorkerNodeSetup

    + +

    Returns void

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

    • Protected beforeTaskExecutionHook

    + +

    Returns void

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitDynamicWorkerCreationEvents

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

    • Private checkAndEmitTaskExecutionEvents

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

    • Private checkAndEmitTaskQueuingEvents

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

    • Protected checkDynamicPoolSize

    Returns void

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

    • Private checkFilePath

    Returns void

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

    • Private checkMessageWorkerId

    + +

    Returns void

    Throws

    https://nodejs.org/api/errors.html#class-error If the worker id is invalid.

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

    • Private checkNumberOfWorkers

    Returns void

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

    • Private checkPoolOptions

    Returns void

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

    • Private checkValidTasksQueueOptions

    Returns void

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Private chooseWorkerNode

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorkerNode

    + +

    Returns Promise<void>

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

    • enableTasksQueue

    + +

    Returns void

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

    • Private enqueueTask

    Returns number

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

    • execute

    + +

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

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

    • Private executeTask

    + +

    Returns void

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

    • Protected flushTasksQueue

    Returns void

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

    • Private flushTasksQueues

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

    • Protected getWorkerInfo

    + +

    Returns WorkerInfo

    The worker information.

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

    • Private getWorkerNodeKeyByWorker

    + +

    Returns number

    The worker node key if found in the pool worker nodes, -1 otherwise.

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

    • Private getWorkerNodeKeyByWorkerId

    + +

    Returns number

    The worker node key if the worker id is found in the pool worker nodes, -1 otherwise.

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

    • Private handleTaskExecutionResponse

    Returns void

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

    • Private handleWorkerReadyResponse

    Returns void

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

    • Private hasBackPressure

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

    • hasWorkerNodeBackPressure

    + +

    Returns boolean

    true if the worker node has back pressure, false otherwise.

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • listTaskFunctions

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

    • Private redistributeQueuedTasks

    Returns void

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

    • Protected Abstract registerWorkerMessageListener

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

    • Private removeWorkerNode

    + +

    Returns void

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

    • Protected sendKillMessageToWorker

    Returns Promise<void>

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

    • Protected Abstract sendStartupMessageToWorker

    + +

    Returns void

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

    • Private sendStatisticsMessageToWorker

    + +

    Returns void

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

    • Protected Abstract sendToWorker

    + +

    Returns void

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

    • setTasksQueueOptions

    + +

    Returns void

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

    • Private setTasksQueueSize

    Returns void

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

    • setWorkerChoiceStrategy

    + +

    Returns void

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

    • setWorkerChoiceStrategyOptions

    + +

    Returns void

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

    • Protected setupHook

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

    • Private shallCreateDynamicWorker

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

    • Private shallExecuteTask

    Returns boolean

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

    • Private shallUpdateTaskFunctionWorkerUsage

    + +

    Returns boolean

    true if the worker node shall update its task function worker usage, false otherwise.

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

    • Private startPool

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

    • Private taskStealingOnEmptyQueue

    Returns void

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

    • Private tasksQueueSize

    Returns number

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

    • Private tasksStealingOnBackPressure

    Returns void

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

    • Private updateEluWorkerUsage

    Returns void

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

    • Private updateRunTimeWorkerUsage

    Returns void

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

    • Private updateTaskStatisticsWorkerUsage

    Returns void

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

    • Private updateTaskStolenStatisticsWorkerUsage

    Returns void

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

    • Private updateWaitTimeWorkerUsage

    Returns void

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

    • Protected workerListener

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

    Settings

     +

    Settings

    Member Visibility

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

    • Theme

    @@ -1518,72 +1553,30 @@ Can be overridden.

  • updateWaitTimeWorkerUsage
  • workerListener
    • -
    +

    Generated using TypeDoc

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