FixedThreadPool | poolifier

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

+FixedThreadPool | poolifier - v2.6.19

@@ -45,7 +45,7 @@

DynamicThreadPool

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

@@ -72,7 +72,9 @@ info maxSize minSize +ready type +utilization worker

@@ -80,6 +82,7 @@

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

Properties

@@ -143,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.

@@ -152,7 +160,7 @@

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

`Protected` `Readonly` filePath

filePath: string

@@ -161,7 +169,7 @@

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

`Protected` `Readonly` numberOfWorkers

numberOfWorkers: number

@@ -170,7 +178,7 @@

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

`Protected` `Readonly` opts

opts: ThreadPoolOptions = {}

@@ -179,7 +187,7 @@

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

`Protected` promiseResponseMap

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

@@ -193,7 +201,7 @@

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

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

@@ -202,16 +210,16 @@

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

`Readonly` workerNodes

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

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

Pool worker nodes.

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

Accessors

@@ -226,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

@@ -328,7 +358,7 @@ Can be overridden.

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

`Protected` afterWorkerSetup

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

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

`Protected` createAndSetupWorker

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

`Protected` createWorker

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

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

`Protected` destroyWorker

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

enableTasksQueue

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

execute

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

registerWorkerMessageListener<Message>(worker, listener): void
+
Registers a listener callback on the given worker.
+
+
+
Type Parameters
+
- +
  Message
+
+
Parameters
+
- +
  worker: Worker
  +
  The worker which should register a listener.
  +
  +
- +
  listener: ((message) => void)
  +
  The message listener callback.
  +
  +
  +
  - +
    - (message): void
    - +
      +
      Parameters
      +
      +
      +
      message: MessageValue<Message, unknown>
      +
      Returns void
+
Returns void
+
+
Overrides AbstractPool.registerWorkerMessageListener
+
- 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

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

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

`Protected` workerListener

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

Parameters

message: MessageValue<Message, unknown>

Returns void