X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FDynamicThreadPool.html;h=f6495e279a204f5ba19c7dc378617f980e5bffea;hb=2a6631992868d900762f62e4c228dce4e4ee549a;hp=46fc69242b9afb0bfacdb1d5b79a47a1559ccb7f;hpb=4101537483d2883af1f76ef2366bb7e92d0d3c4e;p=poolifier.git diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 46fc6924..76ccf9cf 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,4 +1,4 @@ -DynamicThreadPool | poolifier
+DynamicThreadPool | poolifier
  • Preparing search index...
  • -
  • The search index is not available
poolifier
+
  • The search index is not available
  • poolifier
    -
    +
    • poolifier
    • @@ -18,31 +18,34 @@

      A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.

      This thread pool creates new threads when the others are busy, up to the maximum number of threads. -When the maximum number of threads is reached, an event is emitted. If you want to listen to this event, use the pool's emitter.

      - -

      Author

      Alessandro Pio Ardizio

      +When the maximum number of threads is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's emitter.

      +
      +
      +

      Author

      Alessandro Pio Ardizio

      -

      Since

      0.0.1

      +

      Since

      0.0.1

      -
      +

      Type Parameters

      -
        +
        • -

          Data = unknown

          -

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

          -
        • +

          Data = unknown

          +

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

          +
          +
        • -

          Response = unknown

          -

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

          -
      +

      Response = unknown

      +

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

      +
      +

    Hierarchy

    +
  • Defined in src/pools/thread/dynamic.ts:15
  • @@ -50,593 +53,654 @@ When the maximum number of threads is reached, an event is emitted. If you want

    Constructors

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

        -
        +

        Type Parameters

        -
          +
          • -

            Data = unknown

          • +

            Data = unknown

          • -

            Response = unknown

        +

        Response = unknown

      Parameters

      • -
        min: number
        +
        min: number

        Minimum number of threads which are always active.

        -
      • +
      +
    • -
      max: number
      +
      max: number

      Maximum number of threads that can be created by 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 dynamic thread pool.

    -
  • -

    Returns DynamicThreadPool<Data, Response>

    +
    +

    Returns DynamicThreadPool<Data, Response>

    +
    +
  • Defined in src/pools/thread/dynamic.ts:27
  • Properties

    -
    - -
    emitter?: PoolEmitter
    -
    -

    Inherit Doc

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

    The execution response promise map.

      -
    • key: This is the message Id of each submitted task.
    • -
    • value: An object that contains the worker, the resolve function and the reject function.
    • +
    • 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 and resolve/reject the promise based on the message.

    -
    -
    - -
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>
    -

    Worker choice strategy instance implementing the worker choice algorithm.

    -

    Default to a strategy implementing a round robin algorithm.

    -
    +
    + +
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>
    +

    Worker choice strategy context referencing a worker choice algorithm implementation.

    +
    +
    -
    - - -
    -

    Inherit Doc

    -
    - -
    workersTasksUsage: Map<ThreadWorkerWithMessageChannel, TasksUsage> = ...
    -
    -

    Inherit Doc

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

    Pool worker nodes.

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

    -
    - -
      +
      + +
      • get busy(): boolean
      • -
        -

        Inherit Doc

        -

        Returns boolean

      -
      - -
    +
    + +
      +
    • get full(): boolean
    • -
      -

      Inherit Doc

      -

      Returns number

    -
    - -
      -
    • get type(): PoolType
    • +

      Whether the pool is full or not.

      +

      The pool filling boolean status.

      +
      +

      Returns boolean

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

      Pool minimum size.

      +
      +

      Returns number

      +
    +
    + +
      +
    • get runTime(): number
    • +
    • +

      Gets the pool run time.

      +
      +

      Returns number

      The pool run time in milliseconds.

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

      Pool type.

      +

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

      +
      +

      Returns "fixed" | "dynamic"

      +
    +
  • Defined in src/pools/thread/dynamic.ts:37
  • +
    + +
    +
    + +

    Methods

    -
    - -
    +
    + +
      +
    • -
      -

      Inherit Doc

      +

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

      +

      Parameters

      -

      Returns void

    +

    Returns void

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

    Returns void

    +
    +
    + +
      +
    • -

      Creates a new worker for this pool and sets it up completely.

      +

      Creates a new dynamic worker and sets it up completely in the pool worker nodes.

      +
      +

      Returns Worker

      New, completely set up dynamic worker.

      -

      Returns

      New, completely set up worker.

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

      Inherit Doc

      +

      Terminates the given worker.

      +

      Parameters

      -

      Returns Promise<void>

    +

    Returns Promise<void>

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

    Returns void

    +
    +
    + +
      +
    • +

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

      +

      Parameters

      • -
        worker: ThreadWorkerWithMessageChannel
      • +
        Optional data: Data
        +

        The task input data for the specified worker function. This can only be structured-cloneable data.

        +
        +
      • -
        messageId: number
      -

      Returns Promise<Response>

    -
    - -
      - +
      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

      -
      -

      Type Parameters

      -
        -
      • -

        Message

      +

      Sends a message to the given worker.

      +

      Parameters

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

            Parameters

            -
              +
              worker: Worker
              +

              The worker which should receive the message.

              +
              +
            • -
              message: MessageValue<Message, unknown>
            -

            Returns void

      -

      Returns void

    -
    - - +

    Returns void

    +
    +
    + +
    -
    - - +

    Returns void

    +
    +
    + +
      +
    • -
      -

      Inherit Doc

      +

      Sets the worker choice strategy in this pool.

      +

      Parameters

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

        The worker choice strategy.

        +
        +
      • -
        message: MessageValue<Data, unknown>
      -

      Returns void

    +

    Returns void

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

      Inherit Doc

      +

      Sets the worker choice strategy options in this pool.

      +

      Parameters

      • -
        workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
      -

      Returns void

    -
    - - +

    Returns void

    +
    +
    + +
      +
    • -

      Setup hook that can be overridden by a Poolifier pool implementation -to run code before workers are created in the abstract constructor.

      +

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

      -

      Returns void

    -
    - -
    +
    + +
      +
    • -

      This function is the listener registered for each worker.

      - -

      Returns

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

      +

      This function is the listener registered for each worker message.

      -

      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.

            - -

            Returns

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

            +

            This function is the listener registered for each worker message.

            Parameters

            • -
              message: MessageValue<Response, unknown>
            -

            Returns void

      +

      Returns void

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

      + +
    +
    - +
    +
    +
    +

    On This Page

    - -
    +
  • constructor
  • +
  • emitter
  • +
  • filePath
  • +
  • max
  • +
  • numberOfWorkers
  • +
  • opts
  • +
  • promiseResponseMap
  • +
  • workerChoiceStrategyContext
  • +
  • workerNodes
  • +
  • busy
  • +
  • full
  • +
  • info
  • +
  • maxSize
  • +
  • minSize
  • +
  • runTime
  • +
  • type
  • +
  • utilization
  • +
  • worker
  • +
  • afterTaskExecutionHook
  • +
  • afterWorkerSetup
  • +
  • beforeTaskExecutionHook
  • +
  • createAndSetupDynamicWorker
  • +
  • createAndSetupWorker
  • +
  • createWorker
  • +
  • destroy
  • +
  • destroyWorker
  • +
  • enableTasksQueue
  • +
  • execute
  • +
  • internalBusy
  • +
  • isMain
  • +
  • sendToWorker
  • +
  • setTasksQueueOptions
  • +
  • setWorkerChoiceStrategy
  • +
  • setWorkerChoiceStrategyOptions
  • +
  • setupHook
  • +
  • workerListener
  • + +

    Generated using TypeDoc

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