X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=a4a272b70f3eca7faa11a45859de6cdf166d38a6;hb=76b46937556ea55049d5c413aa0a77d0c7f47f48;hp=4d36975579ad53bfcae976840e089ed999764353;hpb=aba8d9bd41f1bd46f3cc3863c0c2e74bdfacb7b6;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 4d369755..a4a272b7 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -FixedThreadPool | poolifier

+FixedThreadPool | poolifier - v2.6.19

@@ -17,7 +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.

Author

Alessandro Pio Ardizio

@@ -29,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:34

@@ -73,14 +72,17 @@ info maxSize minSize +ready type +utilization worker

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

Properties

@@ -145,8 +150,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.

@@ -154,7 +160,7 @@

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

`Protected` `Readonly` filePath

filePath: string

@@ -163,7 +169,7 @@

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

`Protected` `Readonly` numberOfWorkers

numberOfWorkers: number

@@ -172,7 +178,7 @@

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

`Protected` `Readonly` opts

opts: ThreadPoolOptions = {}

@@ -181,10 +187,10 @@

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

`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:74

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<ThreadWorkerWithMessageChannel, Data, Response>

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

Worker choice strategy context referencing a worker choice algorithm implementation.

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

`Readonly` workerNodes

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

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

Pool worker nodes.

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

Accessors

@@ -228,7 +234,7 @@

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

`Private` ready

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

`Protected` type

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

`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:447

`Protected` worker

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

Methods

@@ -317,12 +345,12 @@ Can be overridden.

Parameters

-
worker: ThreadWorkerWithMessageChannel
+
worker: Worker

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

The received message.

@@ -330,28 +358,28 @@ Can be overridden.

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

`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:102

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

`Protected` beforeTaskExecutionHook

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

`Protected` checkDynamicPoolSize

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

`Protected` createAndSetupDynamicWorker

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

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

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

`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:684

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

`Protected` createWorker

createWorker(): ThreadWorkerWithMessageChannel
createWorker(): Worker
Creates a new worker.

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

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

destroy

destroy(): Promise<void>
-
Terminate 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:431

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

`Protected` destroyWorker

Parameters

-
worker: ThreadWorkerWithMessageChannel
+
worker: Worker

A worker within workerNodes.

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

enableTasksQueue

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

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.
@@ -499,7 +543,51 @@ Can be overridden.
Inherited from AbstractPool.execute
- Defined in src/pools/abstract-pool.ts:396

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

`Protected` getWorkerInfoByWorker

getWorkerInfoByWorker(worker): WorkerInfo
+
Gets the worker information from the given worker.
+
+
+
Parameters
+
- +
  worker: Worker
  +
  The worker.
  +
  +
+
Returns WorkerInfo
The worker information.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-error If the worker is not found.
+
+
Inherited from AbstractPool.getWorkerInfoByWorker
+
- Defined in src/pools/abstract-pool.ts:1067

`Protected` getWorkerNodeKey

getWorkerNodeKey(worker): number
+
Gets the given worker its worker node key.
+
+
+
Parameters
+
- +
  worker: Worker
  +
  The worker.
  +
  +
+
Returns number
The worker node key if found in the pool worker nodes, -1 otherwise.
+ +
+
Inherited from AbstractPool.getWorkerNodeKey
+
- Defined in src/pools/abstract-pool.ts:519

`Protected` internalBusy

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

`Protected` isMain

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

`Protected` registerWorkerMessageListener

Parameters

-
worker: ThreadWorkerWithMessageChannel
+
worker: Worker

The worker which should register a listener.

Parameters

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

message: MessageValue<Message, unknown>

Returns void

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

`Protected` sendStartupMessageToWorker

sendStartupMessageToWorker(worker): void
+
Sends the startup message to the given worker.
+
+
+
Parameters
+
- +
  worker: Worker
  +
  The worker which should receive the startup message.
  +
  +
+
Returns void
+
+
Overrides AbstractPool.sendStartupMessageToWorker
+
- Defined in src/pools/thread/fixed.ts:73

`Protected` sendToWorker

Parameters

-
worker: ThreadWorkerWithMessageChannel
+
worker: Worker

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

The message.

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

setTasksQueueOptions

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

setWorkerChoiceStrategy

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

setWorkerChoiceStrategyOptions

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

`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:454

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

`Protected` workerListener

Parameters

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

message: MessageValue<Response, unknown>

Returns void

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

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

WorkerTypes

availableParallelism

Generated using TypeDoc

\ No newline at end of file

worker: ThreadWorkerWithMessageChannel

worker: Worker