X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FAbstractPool.html;h=4a399b49991b2af364cf7c25c8cc38b57d69c1d4;hb=2c94c3a5da9d6b4a0ac992386907d8a406ee38f7;hp=3e8972e96258662bea8323a7764dbc3ab11fac57;hpb=938d9c678aa8e70e5642feffb90604cf25c993fe;p=poolifier.git diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 3e8972e9..4a399b49 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -18,9 +18,9 @@

Base class that implements some shared logic for all poolifier pools.

-
+

Type Parameters

-
+
  • Defined in src/pools/abstract-pool.ts:35
  • @@ -71,6 +71,7 @@ full numberOfQueuedTasks numberOfRunningTasks +size type
    @@ -85,6 +86,7 @@ checkPoolOptions checkValidTasksQueueOptions checkValidWorkerChoiceStrategy +checkValidWorkerChoiceStrategyOptions chooseWorkerNode createAndSetupWorker createWorker @@ -96,10 +98,8 @@ execute executeTask flushTasksQueue -flushTasksQueueByWorker flushTasksQueues getWorkerNodeKey -getWorkerTasksUsage internalBusy isMain pushWorkerNode @@ -124,9 +124,9 @@
  • Constructs a new poolifier pool.

    -
    +

    Type Parameters

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

    @@ -165,28 +165,28 @@
    +
  • Defined in src/pools/abstract-pool.ts:44
  • filePath: string

    Path to the worker file.

    +
  • Defined in src/pools/abstract-pool.ts:79
  • numberOfWorkers: number

    Number of workers that this pool should manage.

    +
  • Defined in src/pools/abstract-pool.ts:78
  • opts: PoolOptions<Worker>

    Options for the pool.

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

    When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.

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

    Default to a round robin algorithm.

    +
  • Defined in src/pools/abstract-pool.ts:64
  • workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -214,7 +214,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:41
  • Accessors

    @@ -227,7 +227,7 @@

    Returns boolean

    +
  • Defined in src/pools/abstract-pool.ts:320
  • +
  • Defined in src/pools/abstract-pool.ts:313
  • +
  • Defined in src/pools/abstract-pool.ts:218
  • +
  • Defined in src/pools/abstract-pool.ts:208
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:200
  • Methods

    @@ -289,12 +300,12 @@ Can be overridden.

    The worker.

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

    The received message.

  • Returns void

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

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

    +
  • Defined in src/pools/abstract-pool.ts:400
  • Returns TasksQueueOptions

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

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

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

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

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

    +
  • Defined in src/pools/abstract-pool.ts:164
  • +
    + +
    +
  • Defined in src/pools/abstract-pool.ts:446
  • +
  • Defined in src/pools/abstract-pool.ts:509
  • +
  • Defined in src/pools/abstract-pool.ts:493
  • Returns undefined | Task<Data>

    +
  • Defined in src/pools/abstract-pool.ts:647
  • +
  • Defined in src/pools/abstract-pool.ts:363
  • Returns void | Promise<void>

    +
  • Defined in src/pools/abstract-pool.ts:377
  • +
  • Defined in src/pools/abstract-pool.ts:278
  • Returns number

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

    Returns Promise<Response>

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

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

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

    Returns number

    -
    - -
    +
  • Defined in src/pools/abstract-pool.ts:234
  • +
  • Defined in src/pools/abstract-pool.ts:322
  • +
  • Defined in src/pools/abstract-pool.ts:392
  • -

    Returns number

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

    Returns void

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

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

    +
  • Defined in src/pools/abstract-pool.ts:475
  • +
  • Defined in src/pools/abstract-pool.ts:290
  • +
  • Defined in src/pools/abstract-pool.ts:241
  • +
  • Defined in src/pools/abstract-pool.ts:267
  • Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:577
  • +
  • Defined in src/pools/abstract-pool.ts:385
  • Returns number

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

    Returns void

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

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