X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=86fada26adb28db38824ca5ecf87c2b5d236b18c;hb=ef29303558d4caf5ff412db9579ea28346b77f3f;hp=779ee93646effb18cf2db2facd60b6ff67435493;hpb=b9da9d7e74c720f83482a09d1b883fc83d04f4ed;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 779ee936..86fada26 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,13 +1,13 @@ -AbstractPool | poolifier - v2.6.37
+AbstractPool | poolifier - v2.6.45
-
+
  • The search index is not available
    • poolifier - v2.6.45 +
    @@ -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 @@ -133,15 +133,15 @@ sendStartupMessageToWorker sendStatisticsMessageToWorker sendToWorker -setTasksQueueMaxSize setTasksQueueOptions +setTasksQueueSize setWorkerChoiceStrategy setWorkerChoiceStrategyOptions setupHook shallCreateDynamicWorker shallExecuteTask shallUpdateTaskFunctionWorkerUsage -startPool +start taskStealingOnEmptyQueue tasksQueueSize tasksStealingOnBackPressure @@ -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:114

    • 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:116

    • Protected Optional Readonly max

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

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

    • Protected promiseResponseMap

    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.
      • @@ -254,7 +257,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:77

    • Private Readonly startTimestamp

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

    • Private started

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

    Private Readonly starting

    +

    Private starting

    starting: boolean

    Whether the pool is starting or not.

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

    • Protected workerChoiceStrategyContext

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

    • 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:685

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected Abstract type

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

    • Private utilization

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

    • Protected Abstract worker

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

    • 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:1423

    • Protected afterTaskExecutionHook

    + +

    Returns void

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

    • Protected afterWorkerNodeSetup

    + +

    Returns void

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

    • Protected beforeTaskExecutionHook

    + +

    Returns void

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitDynamicWorkerCreationEvents

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

    • Private checkAndEmitTaskExecutionEvents

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

    • Private checkAndEmitTaskQueuingEvents

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

    • 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:557

    • 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:296

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Private chooseWorkerNode

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorkerNode

    + +

    Returns Promise<void>

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

    • enableTasksQueue

    + +

    Returns void

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

    • Private enqueueTask

    Returns number

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

    • execute

    + +

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

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

    • Private executeTask

    + +

    Returns void

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

    • Protected flushTasksQueue

    Returns void

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

    • Private flushTasksQueues

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

    • Protected getWorkerInfo

    -

    Returns undefined | WorkerInfo

    The worker information.

    + +
    +

    Returns WorkerInfo

    The worker information.

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

    • Private getWorkerNodeKeyByWorker

    + +

    Returns number

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

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

    • 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:588

    • Private handleTaskExecutionResponse

    Returns void

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

    • Private handleWorkerReadyResponse

    Returns void

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

    • Private hasBackPressure

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

    • hasWorkerNodeBackPressure

    + +

    Returns boolean

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

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • listTaskFunctions

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

    • Private redistributeQueuedTasks

    Returns void

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

    • Protected Abstract registerWorkerMessageListener

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

    • Private removeWorkerNode

    + +

    Returns void

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

    • Protected sendKillMessageToWorker

    Returns Promise<void>

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

    • Protected Abstract sendStartupMessageToWorker

    + +

    Returns void

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

    • Private sendStatisticsMessageToWorker

    + +

    Returns void

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

    • Protected Abstract sendToWorker

    + +

    Returns void

    -
    -

    Private setTasksQueueMaxSize

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

    • setTasksQueueOptions

    + +

    Returns void

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

    Private setTasksQueueSize

    +

    setWorkerChoiceStrategy

    + +

    Returns void

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

    • setWorkerChoiceStrategyOptions

    + +

    Returns void

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

    • Protected setupHook

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

    • Private shallCreateDynamicWorker

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

    • Private shallExecuteTask

    Returns boolean

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

    • Private shallUpdateTaskFunctionWorkerUsage

    + +

    Returns boolean

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

    -
    -

    Private startPool

    -
    +
    +

    start

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

    • Private taskStealingOnEmptyQueue

    Returns void

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

    • Private tasksQueueSize

    Returns number

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

    • Private tasksStealingOnBackPressure

    Returns void

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

    • Private updateEluWorkerUsage

    Returns void

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

    • Private updateRunTimeWorkerUsage

    Returns void

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

    • Private updateTaskStatisticsWorkerUsage

    Returns void

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

    • Private updateTaskStolenStatisticsWorkerUsage

    Returns void

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

    • Private updateWaitTimeWorkerUsage

    Returns void

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

    • Protected workerListener

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

    Settings

     +

    Settings

    Member Visibility

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

    • Theme

    @@ -1499,15 +1538,15 @@ Can be overridden.

  • sendStartupMessageToWorker
  • sendStatisticsMessageToWorker
  • sendToWorker
    • -
  • setTasksQueueMaxSize
  • setTasksQueueOptions
    • +
  • setTasksQueueSize
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
  • setupHook
  • shallCreateDynamicWorker
  • shallExecuteTask
  • shallUpdateTaskFunctionWorkerUsage
    • -
  • startPool
    • +
  • start
  • taskStealingOnEmptyQueue
  • tasksQueueSize
  • tasksStealingOnBackPressure
    • @@ -1518,71 +1557,30 @@ Can be overridden.

  • updateWaitTimeWorkerUsage
  • workerListener
    • -
    +

    Generated using TypeDoc

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