X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=f959865bc869ed98dcca0b015ecf864bebeb1814;hb=3557031d88b5ff00ea86695728b3ba3af46e9faa;hp=b8d02a3b8d2306644cd511e74b60732eaf82652f;hpb=15d6dfaf877ec6a99e2bde48cb3c8a9e8671c075;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index b8d02a3b..f959865b 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -FixedThreadPool | poolifier

+FixedThreadPool | poolifier - v2.6.12

@@ -17,8 +17,6 @@

Class FixedThreadPool<Data, Response>

A thread pool with a fixed number of threads.

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

This pool selects the threads in a round robin fashion.

Author

Alessandro Pio Ardizio

@@ -30,24 +28,24 @@

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.

Hierarchy

AbstractPool<ThreadWorkerWithMessageChannel, Data, Response> +
AbstractPool<Worker, Data, Response>
- FixedThreadPool
  - DynamicThreadPool

Defined in src/pools/thread/fixed.ts:32

@@ -74,15 +72,19 @@ info maxSize minSize +ready +starting type +utilization worker

Methods

afterTaskExecutionHook -afterWorkerSetup +afterWorkerSetup beforeTaskExecutionHook -chooseWorkerNode +checkDynamicPoolSize +createAndSetupDynamicWorker createAndSetupWorker createWorker destroy @@ -91,7 +93,6 @@ execute internalBusy isMain -registerWorkerMessageListener sendToWorker setTasksQueueOptions setWorkerChoiceStrategy @@ -129,7 +130,7 @@

opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}

opts: ThreadPoolOptions = {}

Options for this fixed thread pool.

@@ -137,7 +138,7 @@

Defined in src/pools/thread/fixed.ts:43

Properties

@@ -146,8 +147,9 @@

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.
'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.
'error': Emitted when an uncaught error occurs.
'taskError': Emitted when an error occurs while executing a task.

@@ -155,7 +157,7 @@

Defined in src/pools/abstract-pool.ts:59

`Protected` `Readonly` filePath

filePath: string

@@ -164,7 +166,7 @@

Defined in src/pools/abstract-pool.ts:97

`Protected` `Readonly` numberOfWorkers

numberOfWorkers: number

@@ -173,19 +175,19 @@

Defined in src/pools/abstract-pool.ts:96

`Protected` `Readonly` opts

opts: PoolOptions<ThreadWorkerWithMessageChannel>

Options for the pool.

opts: ThreadPoolOptions = {}

Options for this fixed thread pool.

Defined in src/pools/thread/fixed.ts:46

`Protected` promiseResponseMap

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

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

The execution response promise map.

key: The message id of each submitted task.

Defined in src/pools/abstract-pool.ts:69

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>

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:77

`Readonly` workerNodes

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

workerNodes: IWorkerNode<Worker, Data>[] = []

Pool worker nodes.

Defined in src/pools/abstract-pool.ts:56

Accessors

@@ -230,7 +231,7 @@

Defined in src/pools/thread/fixed.ts:96

`Private` ready

get ready(): boolean
+
Returns boolean
+
Inherited from AbstractPool.ready
+
- Defined in src/pools/abstract-pool.ts:413

`Private` starting

get starting(): boolean
+
Returns boolean
+
Inherited from AbstractPool.starting
+
- Defined in src/pools/abstract-pool.ts:405

`Protected` type

Defined in src/pools/thread/fixed.ts:76

`Private` utilization

get utilization(): number
+
Gets the approximate pool utilization.
+
+
Returns number
The pool utilization.
+ +
+
Inherited from AbstractPool.utilization
+
- Defined in src/pools/abstract-pool.ts:425

`Protected` worker

Defined in src/pools/thread/fixed.ts:81

Methods

@@ -319,12 +351,12 @@ Can be overridden.

Parameters

-
worker: ThreadWorkerWithMessageChannel
+
worker: Worker

The worker.
-
message: MessageValue<Response, Worker | MessagePort>
+
message: MessageValue<Response, unknown>

The received message.

@@ -332,32 +364,32 @@ Can be overridden.

Defined in src/pools/abstract-pool.ts:689

`Protected` afterWorkerSetup

afterWorkerSetup(worker): void
-
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
- -
  worker: ThreadWorkerWithMessageChannel
  +
  worker: Worker
  
  The newly created worker.
Returns void
-
Overrides AbstractPool.afterWorkerSetup
+
Inherited from AbstractPool.afterWorkerSetup
- Defined in src/pools/thread/fixed.ts:90

Defined in src/pools/abstract-pool.ts:924

`Protected` beforeTaskExecutionHook

beforeTaskExecutionHook(workerNodeKey): void
beforeTaskExecutionHook(workerNodeKey, task): void
Hook executed before the worker task execution. Can be overridden.
@@ -369,75 +401,96 @@ Can be overridden.

workerNodeKey: number

The worker node key.

+
+
task: Task<Data>
+
The task to execute.
+

Returns void

`Protected` chooseWorkerNode

Defined in src/pools/abstract-pool.ts:668

`Protected` checkDynamicPoolSize

checkDynamicPoolSize(min, max): void
+
+
Parameters
+
- +
  min: number
- +
  max: number
+
Returns void
+
Inherited from AbstractPool.checkDynamicPoolSize
+
- Defined in src/pools/abstract-pool.ts:161

`Protected` createAndSetupDynamicWorker

chooseWorkerNode(): number
createAndSetupDynamicWorker(): Worker
-
Chooses a worker node for the next task.
-
The default worker choice strategy uses a round robin algorithm to distribute the load.
+
Creates a new dynamic worker and sets it up completely in the pool worker nodes.

-
Returns number
The worker node key
+
Returns Worker
New, completely set up dynamic worker.
-
Inherited from AbstractPool.chooseWorkerNode
+
Inherited from AbstractPool.createAndSetupDynamicWorker
- Defined in src/pools/abstract-pool.ts:532

Defined in src/pools/abstract-pool.ts:1007

`Protected` createAndSetupWorker

createAndSetupWorker(): ThreadWorkerWithMessageChannel
createAndSetupWorker(): Worker
Creates a new worker and sets it up completely in the pool worker nodes.

-
Returns ThreadWorkerWithMessageChannel
New, completely set up worker.
+
Returns Worker
New, completely set up worker.
Inherited from AbstractPool.createAndSetupWorker
- Defined in src/pools/abstract-pool.ts:596

Defined in src/pools/abstract-pool.ts:941

`Protected` createWorker

createWorker(): ThreadWorkerWithMessageChannel
createWorker(): Worker
-
Returns a newly created worker.
+
Creates a new worker.

-
Returns ThreadWorkerWithMessageChannel
+
Returns Worker
Newly created worker.
+
Overrides AbstractPool.createWorker
- Defined in src/pools/thread/fixed.ts:83

Defined in src/pools/thread/fixed.ts:68

destroy

destroy(): Promise<void>
-
Shutdowns every current worker in this pool.
+
Terminates every current worker in this pool.

Returns Promise<void>
Inherited from AbstractPool.destroy
- Defined in src/pools/abstract-pool.ts:415

Defined in src/pools/abstract-pool.ts:623

`Protected` destroyWorker

destroyWorker(worker): Promise<void>
-
Shutdowns the given worker.
+
Terminates the given worker.
Parameters
- -
  worker: ThreadWorkerWithMessageChannel
  +
  worker: Worker
  
  A worker within workerNodes.
@@ -445,7 +498,7 @@ Can be overridden.
Overrides AbstractPool.destroyWorker
- Defined in src/pools/thread/fixed.ts:59

Defined in src/pools/thread/fixed.ts:57

enableTasksQueue

Defined in src/pools/abstract-pool.ts:528

execute

Optional data: Data
-
The task input data for the specified worker function. This can only be serializable data.
+
The task input data for the specified worker function. This can only be structured-cloneable data.
@@ -496,16 +549,20 @@ Can be overridden.
Inherited from AbstractPool.execute
- Defined in src/pools/abstract-pool.ts:380

Defined in src/pools/abstract-pool.ts:588

`Protected` internalBusy

internalBusy(): boolean
-
Returns boolean
+
Whether worker nodes are executing at least one task.
+
+
Returns boolean
Worker nodes busyness boolean status.
+ +
Inherited from AbstractPool.internalBusy
- Defined in src/pools/abstract-pool.ts:371

Defined in src/pools/abstract-pool.ts:579

`Protected` isMain

`Protected` registerWorkerMessageListener

registerWorkerMessageListener<Message>(worker, listener): void
-
Registers a listener callback on the given worker.
-
-
-
Type Parameters
-
- -
  Message
-
-
Parameters
-
- -
  worker: ThreadWorkerWithMessageChannel
  -
  The worker which should register a listener.
  -
  -
- -
  listener: ((message) => void)
  -
  The message listener callback.
  -
  -
  -
  - -
    - (message): void
    - -
      -
      Parameters
      -
      -
      -
      message: MessageValue<Message, Worker | MessagePort>
      -
      Returns void
-
Returns void
-
-
Overrides AbstractPool.registerWorkerMessageListener
-
- Defined in src/pools/thread/fixed.ts:75

Defined in src/pools/thread/fixed.ts:52

`Protected` sendToWorker

Parameters

-
worker: ThreadWorkerWithMessageChannel
+
worker: Worker

The worker which should receive the message.
-
message: MessageValue<Data, Worker | MessagePort>
+
message: MessageValue<Data, unknown>

The message.

Defined in src/pools/thread/fixed.ts:63

setTasksQueueOptions

Defined in src/pools/abstract-pool.ts:540

setWorkerChoiceStrategy

Parameters

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

The worker choice strategy.

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

setWorkerChoiceStrategyOptions

Defined in src/pools/abstract-pool.ts:517

`Protected` setupHook

setupHook(): void
-
Setup hook to execute code before worker node are created in the abstract constructor. -Can be overridden
+
Setup hook to execute code before worker nodes are created in the abstract constructor. +Can be overridden.

Returns void
Inherited from AbstractPool.setupHook
- Defined in src/pools/abstract-pool.ts:438