X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=4782daeebb94564871a2e6088604d5a99b48fea0;hb=202bcb6b999895ba5c5ef42eccd6a95836d21602;hp=e498d41b0f1f8d59f0b6943430e09fe606faadc6;hpb=aac8863d208eadcb0ecb33dc44d045c26f5a444f;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index e498d41b..4782daee 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -29,12 +29,12 @@
  • Data = unknown

    -

    Type of data sent to the worker. This can only be serializable data.

    +

    Type of data sent to the worker. This can only be structured-cloneable data.

  • Response = unknown

    -

    Type of execution response. This can only be serializable data.

    +

    Type of execution response. This can only be structured-cloneable data.

  • @@ -49,7 +49,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:49
  • @@ -66,6 +66,7 @@ numberOfWorkers opts promiseResponseMap +startTimestamp workerChoiceStrategyContext workerNodes
    @@ -76,7 +77,9 @@ info maxSize minSize +runTime type +utilization worker
    @@ -92,7 +95,8 @@ checkValidTasksQueueOptions checkValidWorkerChoiceStrategy checkValidWorkerChoiceStrategyOptions -chooseWorkerNode +chooseWorkerNode +createAndSetupDynamicWorker createAndSetupWorker createWorker dequeueTask @@ -104,13 +108,16 @@ executeTask flushTasksQueue flushTasksQueues -getTaskStatistics +getWorkerById +getWorkerId getWorkerNodeKey getWorkerUsage +handleTaskExecutionResponse +handleWorkerStartedMessage internalBusy isMain pushWorkerNode -registerWorkerMessageListener +registerWorkerMessageListener removeWorkerNode sendToWorker setTasksQueueOptions @@ -119,6 +126,8 @@ setWorkerNodeTasksUsage setWorkerStatistics setupHook +shallCreateDynamicWorker +tasksMaxQueueSize tasksQueueSize updateEluWorkerUsage updateRunTimeWorkerUsage @@ -139,7 +148,7 @@

    Type Parameters

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

    @@ -183,7 +192,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:58
  • filePath: string
    @@ -191,7 +200,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:96
  • numberOfWorkers: number
    @@ -199,7 +208,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:95
  • opts: PoolOptions<Worker>
    @@ -207,7 +216,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:97
  • promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -220,7 +229,15 @@
    +
  • Defined in src/pools/abstract-pool.ts:68
  • +
    + +
    startTimestamp: number
    +

    The start timestamp of the pool.

    +
    +
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    @@ -228,7 +245,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:76
  • workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -237,7 +254,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:55
  • Accessors

    @@ -251,7 +268,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:450
  • +
  • Defined in src/pools/abstract-pool.ts:441
  • +
  • Defined in src/pools/abstract-pool.ts:250
  • +
  • Defined in src/pools/abstract-pool.ts:347
  • +
  • Defined in src/pools/abstract-pool.ts:342
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:332
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:337
  • Methods

    @@ -340,21 +381,21 @@ Can be overridden.

  • -
    message: MessageValue<Response, unknown, Worker | MessagePort>
    +
    message: MessageValue<Response, unknown>

    The received message.

  • Returns void

    +
  • Defined in src/pools/abstract-pool.ts:555
  • - +
    +
  • Defined in src/pools/abstract-pool.ts:747
  • +
  • Defined in src/pools/abstract-pool.ts:539
  • Returns TasksQueueOptions

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

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

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

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

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

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

    -
    - -
    +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:689
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:757
  • +
  • Defined in src/pools/abstract-pool.ts:739
  • Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:974
  • +
  • Defined in src/pools/abstract-pool.ts:500
  • +
  • Defined in src/pools/abstract-pool.ts:515
  • +
  • Defined in src/pools/abstract-pool.ts:406
  • Returns number

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

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

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

    Returns undefined | Worker

    The worker if found in the pool worker nodes, undefined otherwise.

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

    Returns number

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

    +

    Returns number

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

    +
  • Defined in src/pools/abstract-pool.ts:366
  • Returns WorkerUsage

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

    Returns void

    Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:716
  • +
  • Defined in src/pools/abstract-pool.ts:418
  • +
  • Defined in src/pools/abstract-pool.ts:373
  • +
  • Defined in src/pools/abstract-pool.ts:395
  • +
  • Defined in src/pools/abstract-pool.ts:886
  • Returns void

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

    Returns number

    +
  • Defined in src/pools/abstract-pool.ts:978
  • +
    message: MessageValue<Response, unknown>

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:637
  • +
    message: MessageValue<Response, unknown>

    Returns void

    +
  • Defined in src/pools/abstract-pool.ts:577
  • +
    message: MessageValue<Response, unknown>

    Returns void

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:815
  • +
  • WorkerTypes
  • +
  • availableParallelism
  • Generated using TypeDoc

    \ No newline at end of file