X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=973447b5c5477e1291f22fd348f27e2e79730b65;hb=18fea9f10a9d1fd8bbbc4738284939868faa0db5;hp=88503f4b01c351be97f5300d28499c699e150755;hpb=fddf9cc424b3ace38fd414899c666c76a03c3aff;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 88503f4b..973447b5 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier
+FixedClusterPool | poolifier - v2.6.8
  • Preparing search index...
    • -
  • The search index is not available
poolifier
+
  • The search index is not available
    • poolifier - v2.6.8
    @@ -17,8 +17,6 @@

    Class FixedClusterPool<Data, Response>

    A cluster pool with a fixed number of workers.

    -

    It is possible to perform tasks in sync or asynchronous mode as you prefer.

    -

    This pool selects the workers in a round robin fashion.

    Author

    Christopher Quadflieg

    @@ -30,12 +28,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.

    @@ -47,7 +45,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:38
    • @@ -75,14 +73,15 @@ maxSize minSize type +utilization worker

    Methods

    afterTaskExecutionHook -afterWorkerSetup +afterWorkerSetup beforeTaskExecutionHook -chooseWorkerNode +createAndSetupDynamicWorker createAndSetupWorker createWorker destroy @@ -91,7 +90,6 @@ execute internalBusy isMain -registerWorkerMessageListener sendToWorker setTasksQueueOptions setWorkerChoiceStrategy @@ -137,7 +135,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:49

    • Properties

    @@ -155,7 +153,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:60

    • Protected Readonly filePath

    filePath: string
    @@ -164,7 +162,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:98

    • Protected Readonly numberOfWorkers

    numberOfWorkers: number
    @@ -173,7 +171,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:97

    • Protected Readonly opts

    opts: ClusterPoolOptions = {}
    @@ -182,7 +180,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:52

    • Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
    @@ -196,17 +194,16 @@
    +
  • Defined in src/pools/abstract-pool.ts:70

    • Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    -

    Default to a round robin algorithm.

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

    • Readonly workerNodes

    workerNodes: WorkerNode<Worker, Data>[] = []
    @@ -215,7 +212,7 @@
    +
  • Defined in src/pools/abstract-pool.ts:57

    • Accessors

    @@ -230,7 +227,7 @@
    +
  • Defined in src/pools/cluster/fixed.ts:107

    • Protected full

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

    • info

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

    • Protected maxSize

    +
  • Defined in src/pools/cluster/fixed.ts:102

    • Protected minSize

    +
  • Defined in src/pools/cluster/fixed.ts:97

    • Protected type

    +
  • Defined in src/pools/cluster/fixed.ts:87
    • +
    +

    Private utilization

    +

    Protected worker

    +
  • Defined in src/pools/cluster/fixed.ts:92

    • Methods

    @@ -324,7 +334,7 @@ Can be overridden.

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

    The received message.

    • @@ -332,14 +342,14 @@ Can be overridden.

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

    Protected afterWorkerSetup

    -
      +
      • -

        Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes.

        -

        Can be used to update the maxListeners or binding the main-worker<->worker connection if not bind by default.

        +

        Function that can be hooked up when a worker has been newly created and moved to the pool worker nodes. +Can be overridden.

        Parameters

        @@ -351,13 +361,13 @@ Can be overridden.

      Returns void

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

    • Protected beforeTaskExecutionHook

    Returns void

    -
    -

    Protected chooseWorkerNode

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

    Protected createAndSetupDynamicWorker

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

    • Protected createAndSetupWorker

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

    • Protected createWorker

    +
  • Defined in src/pools/cluster/fixed.ts:82

    • destroy

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

    • Protected destroyWorker

    +
  • Defined in src/pools/cluster/fixed.ts:68

    • enableTasksQueue

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

    • execute

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

    • Protected internalBusy

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

    • Protected isMain

    -
    -

    Protected registerWorkerMessageListener

    -
    +
  • Defined in src/pools/cluster/fixed.ts:63

    • Protected sendToWorker

    @@ -583,7 +561,7 @@ Can be overridden.

    +
  • Defined in src/pools/cluster/fixed.ts:77

    • setTasksQueueOptions

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

    • setWorkerChoiceStrategy

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

    • setWorkerChoiceStrategyOptions

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

    • Protected setupHook

    +
  • Defined in src/pools/cluster/fixed.ts:58

    • Protected workerListener

    Returns void

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

    +
  • Defined in src/pools/abstract-pool.ts:973
    • @@ -723,11 +701,12 @@ Can be overridden

  • maxSize
  • minSize
  • type
    • +
  • utilization
  • worker
  • afterTaskExecutionHook
    • -
  • afterWorkerSetup
    • +
  • afterWorkerSetup
  • beforeTaskExecutionHook
    • -
  • chooseWorkerNode
    • +
  • createAndSetupDynamicWorker
  • createAndSetupWorker
  • createWorker
  • destroy
    • @@ -736,7 +715,6 @@ Can be overridden

  • execute
  • internalBusy
  • isMain
    • -
  • registerWorkerMessageListener
  • sendToWorker
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
    • @@ -744,7 +722,7 @@ Can be overridden

  • setupHook
  • workerListener
    • -
    +
  • WorkerTypes
    • +
  • availableParallelism

    • Generated using TypeDoc

    \ No newline at end of file