X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=e382e9e16e85fa1b4736e8df9cfd0842e9c02057;hb=3eed67feea0f527e3ee31a6ebb1063883eec3855;hp=e2a2a08256775bd466e5b39bf6503bf8743de05c;hpb=b7e141c40bccfd7a4ec0ff98b7829f7d296f048b;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index e2a2a082..e382e9e1 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,13 +1,13 @@ -AbstractPool | poolifier - v2.6.41
+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,18 +133,22 @@ sendStartupMessageToWorker sendStatisticsMessageToWorker sendToWorker +setTaskStealing setTasksQueueOptions setTasksQueueSize +setTasksStealingOnBackPressure setWorkerChoiceStrategy setWorkerChoiceStrategyOptions setupHook shallCreateDynamicWorker shallExecuteTask shallUpdateTaskFunctionWorkerUsage -startPool +start taskStealingOnEmptyQueue tasksQueueSize tasksStealingOnBackPressure +unsetTaskStealing +unsetTasksStealingOnBackPressure updateEluWorkerUsage updateRunTimeWorkerUsage updateTaskStatisticsWorkerUsage @@ -155,7 +159,7 @@

    Constructors

    -

    constructor

    +

    constructor

    • @@ -176,19 +180,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 +216,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:68

    • Protected Readonly filePath

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

    • Protected Optional Readonly max

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

    • Protected Readonly numberOfWorkers

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

    • Protected Readonly opts

    opts: PoolOptions<Worker>
    @@ -241,11 +248,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 +261,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:77

    • Private Readonly startTimestamp

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

    • Private started

    started: boolean
    @@ -270,15 +277,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 +293,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:83

    • Readonly Internal workerNodes

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

    • Accessors

    @@ -309,7 +316,7 @@

    Returns boolean

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

    • Protected full

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

    • info

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

    • Protected maxSize

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

    • Protected minSize

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

    • Private ready

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

    • Protected Abstract type

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

    • Private utilization

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

    • Protected Abstract worker

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

    • Methods

    @@ -417,14 +424,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:1469

    • Protected afterTaskExecutionHook

    + +

    Returns void

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

    • Protected afterWorkerNodeSetup

    + +

    Returns void

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

    • Protected beforeTaskExecutionHook

    + +

    Returns void

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

    • Private buildTasksQueueOptions

    Returns TasksQueueOptions

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

    • Private checkAndEmitDynamicWorkerCreationEvents

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

    • Private checkAndEmitTaskExecutionEvents

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

    • Private checkAndEmitTaskQueuingEvents

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

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

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

    • Private checkValidWorkerChoiceStrategy

    Returns void

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

    • Private checkValidWorkerChoiceStrategyOptions

    Returns void

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

    • Private chooseWorkerNode

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

    • Protected createAndSetupDynamicWorkerNode

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

    • Protected createAndSetupWorkerNode

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

    • Protected Abstract createWorker

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

    • Private dequeueTask

    Returns undefined | Task<Data>

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

    • destroy

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

    • Protected Abstract destroyWorkerNode

    + +

    Returns Promise<void>

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

    • enableTasksQueue

    + +

    Returns void

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

    • Private enqueueTask

    Returns number

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

    • execute

    + +

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

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

    • Private executeTask

    + +

    Returns void

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

    • Protected flushTasksQueue

    Returns void

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

    • Private flushTasksQueues

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

    • Protected getWorkerInfo

    + +

    Returns WorkerInfo

    The worker information.

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

    • Private getWorkerNodeKeyByWorker

    + +

    Returns number

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

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

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

    • Private handleTaskExecutionResponse

    Returns void

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

    • Private handleWorkerReadyResponse

    Returns void

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

    • Private hasBackPressure

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

    • hasWorkerNodeBackPressure

    + +

    Returns boolean

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

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

    • Protected internalBusy

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

    • Protected Abstract isMain

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

    • listTaskFunctions

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

    • Private redistributeQueuedTasks

    Returns void

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

    • Protected Abstract registerWorkerMessageListener

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

    • Private removeWorkerNode

    + +

    Returns void

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

    • Protected sendKillMessageToWorker

    Returns Promise<void>

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

    • Protected Abstract sendStartupMessageToWorker

    + +

    Returns void

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

    • Private sendStatisticsMessageToWorker

    + +

    Returns void

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

    • Protected Abstract sendToWorker

    + +

    Returns void

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

    Private setTaskStealing

    +

    setTasksQueueOptions

    + +

    Returns void

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

    • Private setTasksQueueSize

    Returns void

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

    Private setTasksStealingOnBackPressure

    +

    setWorkerChoiceStrategy

    + +

    Returns void

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

    • setWorkerChoiceStrategyOptions

    + +

    Returns void

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

    • Protected setupHook

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

    • Private shallCreateDynamicWorker

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

    • Private shallExecuteTask

    Returns boolean

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

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

    • Private taskStealingOnEmptyQueue

    Returns void

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

    • Private tasksQueueSize

    Returns number

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

    • Private tasksStealingOnBackPressure

    Returns void

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

    Private unsetTaskStealing

    +
    +
    +

    Private unsetTasksStealingOnBackPressure

    +

    Private updateEluWorkerUsage

    Returns void

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

    • Private updateRunTimeWorkerUsage

    Returns void

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

    • Private updateTaskStatisticsWorkerUsage

    Returns void

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

    • Private updateTaskStolenStatisticsWorkerUsage

    Returns void

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

    • Private updateWaitTimeWorkerUsage

    Returns void

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

    • Protected workerListener

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

    Settings

     +

    Settings

    Member Visibility

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

    • Theme

    @@ -1499,18 +1574,22 @@ Can be overridden.

  • sendStartupMessageToWorker
  • sendStatisticsMessageToWorker
  • sendToWorker
    • +
  • setTaskStealing
  • setTasksQueueOptions
  • setTasksQueueSize
    • +
  • setTasksStealingOnBackPressure
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
  • setupHook
  • shallCreateDynamicWorker
  • shallExecuteTask
  • shallUpdateTaskFunctionWorkerUsage
    • -
  • startPool
    • +
  • start
  • taskStealingOnEmptyQueue
  • tasksQueueSize
  • tasksStealingOnBackPressure
    • +
  • unsetTaskStealing
    • +
  • unsetTasksStealingOnBackPressure
  • updateEluWorkerUsage
  • updateRunTimeWorkerUsage
  • updateTaskStatisticsWorkerUsage
    • @@ -1518,72 +1597,30 @@ Can be overridden.

  • updateWaitTimeWorkerUsage
  • workerListener
    • -
    +

    Generated using TypeDoc

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