X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=b1f5eaf91f2efb1311489f54d5a0d838f30a6e1b;hb=f05afd162e34836a52c48b05781750e3421424d8;hp=bef39e3847e3106f8a001d2f57afe019e5cff9f1;hpb=bb3f9b66fa2241864d31937eeced22caab83d17e;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index bef39e38..b1f5eaf9 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -FixedThreadPool | poolifier
+FixedThreadPool | poolifier
+
  • -

    Response = unknown

    -

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

    -
  • +

    Response = unknown

    +

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

    +
    +

    Hierarchy

    @@ -52,208 +55,262 @@

    Constructors

    -
    - -
      - +
      + +
        +
      • Constructs a new poolifier fixed thread pool.

        -
        +

        Type Parameters

        -
          +
          • -

            Data = unknown

          • +

            Data = unknown

          • -

            Response = unknown

        +

        Response = unknown

      Parameters

      • -
        numberOfThreads: number
        +
        numberOfThreads: number

        Number of threads for this pool.

        -
      • +
      +
    • -
      filePath: string
      +
      filePath: string

      Path to an implementation of a ThreadWorker file, which can be relative or absolute.

      -
    • +
    +
  • -
    opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
    +
    opts: ThreadPoolOptions = {}

    Options for this fixed thread pool.

    -
  • -

    Returns FixedThreadPool<Data, Response>

    Properties

    -
    - -
    emitter?: PoolEmitter
    -
    -

    Inherit Doc

    -
    - -
    filePath: string
    -

    Path to the worker-file.

    -
    -
    - -
    numberOfWorkers: number
    +
    + +
    emitter?: PoolEmitter
    +

    Emitter on which events can be listened to.

    +

    Events that can currently be listened to:

    +
      +
    • 'full': Emitted when the pool is dynamic and full.
    • +
    • 'busy': Emitted when the pool is busy.
    • +
    • 'error': Emitted when an uncaught error occurs.
    • +
    • 'taskError': Emitted when an error occurs while executing a task.
    • +
    +
    +
    +
    + +
    filePath: string
    +

    Path to the worker file.

    +
    +
    +
    + +
    numberOfWorkers: number

    Number of workers that this pool should manage.

    -
    -
    - - -

    Options for the pool.

    -
    -
    - -
    promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...
    + +
    +
    + + +

    Options for this fixed thread pool.

    +
    +
    +
    + +
    promiseResponseMap: Map<string, PromiseResponseWrapper<ThreadWorkerWithMessageChannel, Response>> = ...

    The 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.

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

    -
    -
    - -
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    +
  • Defined in src/pools/abstract-pool.ts:64
  • +
    + +
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    Default to a round robin algorithm.

    -
    -
    - -
    workerNodes: WorkerNode<ThreadWorkerWithMessageChannel, Data>[] = []
    -
    -

    Inherit Doc

    +
    + +
    workerNodes: WorkerNode<ThreadWorkerWithMessageChannel, Data>[] = []
    +

    Pool worker nodes.

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

    -
    - -
    +
    + +
    -
    - -
      -
    • get numberOfQueuedTasks(): number
    • +

      Whether the pool is full or not.

      +

      The pool filling boolean status.

      +
      +

      Returns boolean

      +
    +
    + +
    -
    - -
    +
    + +
      +
    • get maxSize(): number
    • -

      Number of tasks running in the pool.

      +

      Pool maximum size.

      -

      Returns number

    -
    - -
    +
    + +
      +
    • get minSize(): number
    • -
      -

      Inherit Doc

      -

      Returns PoolType

    +
    + +
      +
    • get type(): "fixed" | "dynamic"
    • +
    • +

      Pool type.

      +

      If it is 'dynamic', it provides the max property.

      +
      +

      Returns "fixed" | "dynamic"

      +
    +
  • Defined in src/pools/thread/fixed.ts:114
  • +
    + +
      +
    • get worker(): "cluster" | "thread"
    • +
    • +

      Gets the worker type.

      +
      +

      Returns "cluster" | "thread"

      +

    Methods

    -
    - -
    -
    - - +

    Returns void

    +
    +
    + +
      +
    • -
      -

      Inherit Doc

      +

      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.

      +

      Parameters

      -

      Returns void

    -
    - - +

    Returns void

    +
    +
    + +
      +
    • Hook executed before the worker task execution. Can be overridden.

      @@ -301,238 +366,340 @@ Can be overridden.

      Parameters

      • -
        workerNodeKey: number
        +
        workerNodeKey: number

        The worker node key.

        -
      -

      Returns void

    -
    - - +

    Returns void

    +
    +
    + +
      +
    • Chooses a worker node for the next task.

      -

      The default uses a round robin algorithm to distribute the load.

      - -

      Returns

      [worker node key, worker node].

      +

      The default worker choice strategy uses a round robin algorithm to distribute the load.

      -

      Returns [number, WorkerNode<ThreadWorkerWithMessageChannel, Data>]

    -
    - -
    +
    + +
    -
    - -
    +
    + +
    -
    - -
    +
    + +
    -
    - -
    +
    + +
    -
    - - +

    Returns Promise<void>

    +
    +
    + +
      +
    • -
      -

      Inherit Doc

      +

      Enables/disables the worker tasks queue in this pool.

      +

      Parameters

      • -
        data: Data
      -

      Returns Promise<Response>

    -
    - -
      - +
      enable: boolean
      +

      Whether to enable or disable the worker tasks queue.

      +
      +
      +
    • +
      Optional tasksQueueOptions: TasksQueueOptions
      +

      The worker tasks queue options.

      +
      +
    +

    Returns void

    +
    +
    + +
      +
    • -
      -

      Inherit Doc

      -

      Returns number

    -
    - -
      - +

      Executes the specified function in the worker constructor with the task data input parameter.

      +
      +
      +

      Parameters

      +
        +
      • +
        Optional data: Data
        +

        The task input data for the specified worker function. This can only be serializable data.

        +
        +
      • +
      • +
        Optional name: string
        +

        The name of the worker function to execute. If not specified, the default worker function will be executed.

        +
        +
      +

      Returns Promise<Response>

      Promise that will be fulfilled when the task is completed.

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

      Inherit Doc

      -
      +

      Registers a listener callback on the given worker.

      +
      +

      Type Parameters

      -
        +
        • -

          Message

      +

      Message

    Parameters

    • -
      messageChannel: ThreadWorkerWithMessageChannel
    • +
      worker: ThreadWorkerWithMessageChannel
      +

      The worker which should register a listener.

      +
      +
    • -
      listener: ((message: MessageValue<Message, unknown>) => void)
      +
      listener: ((message) => void)
      +

      The message listener callback.

      +
      +
      • -
          -
        • (message: MessageValue<Message, unknown>): void
        • +
            +
          • (message): void
          • Parameters

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

    Returns void

    -

    Returns void

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

      The message.

      +
      +
    +

    Returns void

    +
    +
    + +
      +
    • -
      -

      Inherit Doc

      +

      Sets the worker tasks queue options in this pool.

      +

      Parameters

      • -
        workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
      -

      Returns void

    -
    - -
      - +
      tasksQueueOptions: TasksQueueOptions
      +

      The worker tasks queue options.

      +
      +
    +

    Returns void

    +
    +
    + +
      + +
    • +

      Sets the worker choice strategy in this pool.

      +
      +
      +

      Parameters

      +
        +
      • +
        workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
        +

        The worker choice strategy.

        +
        +
      • +
      • +
        Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
        +

        The worker choice strategy options.

        +
        +
      +

      Returns void

      +
    +
    + +
    +
    + +
      +
    • Setup hook to execute code before worker node are created in the abstract constructor. Can be overridden

      -

      Returns void

    -
    - -
    +
    + +
      +
    • This function is the listener registered for each worker message.

      - -

      Returns

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

      -

      Returns ((message: MessageValue<Response, unknown>) => void)

      +

      Returns ((message) => void)

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

      +
      • -
          -
        • (message: MessageValue<Response, unknown>): void
        • +
            +
          • (message): void
          • This function is the listener registered for each worker message.

            - -

            Returns

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

            Parameters

            • -
              message: MessageValue<Response, unknown>
            -

            Returns void

      +

      Returns void

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

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

    On This Page

    +

    On This Page

    +
  • constructor
  • +
  • emitter
  • +
  • filePath
  • +
  • numberOfWorkers
  • +
  • opts
  • +
  • promiseResponseMap
  • +
  • workerChoiceStrategyContext
  • +
  • workerNodes
  • +
  • busy
  • +
  • full
  • +
  • info
  • +
  • maxSize
  • +
  • minSize
  • +
  • type
  • +
  • worker
  • +
  • afterTaskExecutionHook
  • +
  • afterWorkerSetup
  • +
  • beforeTaskExecutionHook
  • +
  • chooseWorkerNode
  • +
  • createAndSetupWorker
  • +
  • createWorker
  • +
  • destroy
  • +
  • destroyWorker
  • +
  • enableTasksQueue
  • +
  • execute
  • +
  • internalBusy
  • +
  • isMain
  • +
  • registerWorkerMessageListener
  • +
  • sendToWorker
  • +
  • setTasksQueueOptions
  • +
  • setWorkerChoiceStrategy
  • +
  • setWorkerChoiceStrategyOptions
  • +
  • setupHook
  • +
  • workerListener
  • +
  • AbstractPool
  • +
  • AbstractWorker
  • +
  • CircularArray
  • +
  • ClusterWorker
  • +
  • DynamicClusterPool
  • +
  • DynamicThreadPool
  • +
  • FixedClusterPool
  • +
  • FixedThreadPool
  • +
  • PoolEmitter
  • +
  • Queue
  • +
  • ThreadWorker
  • +
  • WorkerChoiceStrategyContext
  • +
  • ClusterPoolOptions
  • +
  • EventLoopUtilizationMeasurementStatistics
  • +
  • IPool
  • +
  • IWorker
  • +
  • IWorkerChoiceStrategy
  • +
  • MeasurementOptions
  • +
  • MeasurementStatistics
  • +
  • MeasurementStatisticsRequirements
  • +
  • MessageValue
  • +
  • PoolInfo
  • +
  • PoolOptions
  • +
  • PromiseResponseWrapper
  • +
  • Task
  • +
  • TaskError
  • +
  • TaskPerformance
  • +
  • TaskStatistics
  • +
  • TaskStatisticsRequirements
  • +
  • TasksQueueOptions
  • +
  • ThreadPoolOptions
  • +
  • WorkerChoiceStrategyOptions
  • +
  • WorkerNode
  • +
  • WorkerOptions
  • +
  • WorkerStatistics
  • +
  • WorkerUsage
  • +
  • Draft
  • +
  • ErrorHandler
  • +
  • ExitHandler
  • +
  • KillBehavior
  • +
  • Measurement
  • +
  • MessageHandler
  • +
  • OnlineHandler
  • +
  • PoolEvent
  • +
  • PoolType
  • +
  • TaskFunctions
  • +
  • ThreadWorkerWithMessageChannel
  • +
  • WorkerAsyncFunction
  • +
  • WorkerChoiceStrategy
  • +
  • WorkerFunction
  • +
  • WorkerSyncFunction
  • +
  • WorkerType
  • +
  • KillBehaviors
  • +
  • Measurements
  • +
  • PoolEvents
  • +
  • PoolTypes
  • +
  • WorkerChoiceStrategies
  • +
  • WorkerTypes
  • Generated using TypeDoc

    \ No newline at end of file