FixedThreadPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedThreadPool.html;h=47a026ff82721c1aa72076170ae95695fc76284d;hb=800480935c90f3847c389dd5dbfca11760e78675;hp=0994ef85cd08068a83fb61e21ccd5406b1735510;hpb=7455be54c58f74c6f0d0dd597aa431a88da0a9d8;p=poolifier.git diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 0994ef85..47a026ff 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,4 +1,4 @@ -FixedThreadPool | poolifier - v2.6.42

+FixedThreadPool | poolifier - v3.0.1

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

DynamicThreadPool

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

@@ -80,32 +80,38 @@

Constructors

@@ -145,13 +151,14 @@

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

Properties

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Emitter on which events can be listened to.

`Optional` emitter

emitter?: EventEmitterAsyncResource

Event emitter integrated with async resource on which events can be listened to. +The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

Events that can currently be listened to:

'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.

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

`Protected` `Readonly` filePath

filePath: string

@@ -175,7 +182,7 @@

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

`Protected` `Optional` `Readonly` max

max?: number

@@ -184,7 +191,7 @@

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

`Protected` `Readonly` numberOfWorkers

numberOfWorkers: number

@@ -193,7 +200,7 @@

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

`Protected` `Readonly` opts

opts: ThreadPoolOptions = {}

@@ -202,11 +209,11 @@

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

`Protected` promiseResponseMap

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

The task execution response promise map.

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

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

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

@@ -225,7 +232,7 @@

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

`Readonly` `Internal` workerNodes

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

@@ -234,7 +241,7 @@

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

Accessors

@@ -249,7 +256,7 @@

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

Methods

addTaskFunction

addTaskFunction(name, fn): Promise<boolean>
+
Adds a task function to this pool. +If a task function with the same name already exists, it will be overwritten.
+
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function.
  +
  +
- +
  fn: TaskFunction<Data, Response>
  +
  The task function.
  +
  +
+
Returns Promise<boolean>
true if the task function was added, false otherwise.
+ +
+
Throws
https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
+ +
Throws
https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.
+
+
Inherited from AbstractPool.addTaskFunction
+
- Defined in src/pools/abstract-pool.ts:807

`Protected` afterTaskExecutionHook

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

`Protected` afterWorkerNodeSetup

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

`Protected` beforeTaskExecutionHook

`Protected` checkDynamicPoolSize

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

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

`Protected` createAndSetupDynamicWorkerNode

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

`Protected` createAndSetupWorkerNode

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

`Protected` createWorker

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

`Protected` deregisterWorkerMessageListener

deregisterWorkerMessageListener<Message>(workerNodeKey, listener): void
+
Deregisters a listener callback on the worker given its worker node key.
+
+
+
Type Parameters
+
- +
  Message
+
+
Parameters
+
- +
  workerNodeKey: number
  +
  The worker node key.
  +
  +
- +
  listener: ((message) => void)
  +
  The message listener callback.
  +
  +
  +
  - +
    - (message): void
    - +
      +
      Parameters
      +
      +
      +
      message: MessageValue<Message, unknown>
      +
      Returns void
+
Returns void
+
+
Overrides AbstractPool.deregisterWorkerMessageListener
+
- Defined in src/pools/thread/fixed.ts:126

destroy

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

`Protected` destroyWorkerNode

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

enableTasksQueue

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

execute

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

`Protected` flushTasksQueue

Returns void

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

`Protected` getWorkerInfo

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

hasTaskFunction

hasTaskFunction(name): boolean
+
Whether the specified task function exists in this pool.
+
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function.
  +
  +
+
Returns boolean
true if the task function exists, false otherwise.
+ +
+
Inherited from AbstractPool.hasTaskFunction
+
- Defined in src/pools/abstract-pool.ts:794

hasWorkerNodeBackPressure

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

`Protected` internalBusy

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

`Protected` isMain

listTaskFunctions

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

listTaskFunctionNames

listTaskFunctions(): string[]
listTaskFunctionNames(): string[]
Lists the names of task function available in this pool.

Returns string[]
The names of task function available in this pool.
-
Inherited from AbstractPool.listTaskFunctions
+
Inherited from AbstractPool.listTaskFunctionNames
- Defined in src/pools/abstract-pool.ts:726

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

`Protected` registerOnceWorkerMessageListener

registerOnceWorkerMessageListener<Message>(workerNodeKey, listener): void
+
Registers once a listener callback on the worker given its worker node key.
+
+
+
Type Parameters
+
- +
  Message
+
+
Parameters
+
- +
  workerNodeKey: number
  +
  The worker node key.
  +
  +
- +
  listener: ((message) => void)
  +
  The message listener callback.
  +
  +
  +
  - +
    - (message): void
    - +
      +
      Parameters
      +
      +
      +
      message: MessageValue<Message, unknown>
      +
      Returns void
+
Returns void
+
+
Overrides AbstractPool.registerOnceWorkerMessageListener
+
- Defined in src/pools/thread/fixed.ts:116

`Protected` registerWorkerMessageListener

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

removeTaskFunction

removeTaskFunction(name): Promise<boolean>
+
Removes a task function from this pool.
+
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function.
  +
  +
+
Returns Promise<boolean>
true if the task function was removed, false otherwise.
+ +
+
Inherited from AbstractPool.removeTaskFunction
+
- Defined in src/pools/abstract-pool.ts:830

`Protected` sendKillMessageToWorker

sendKillMessageToWorker(workerNodeKey, workerId): Promise<void>
sendKillMessageToWorker(workerNodeKey): Promise<void>
Parameters
- -
  workerNodeKey: number
- -
  workerId: number
+
workerNodeKey: number

Returns Promise<void>

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

`Protected` sendStartupMessageToWorker

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

`Protected` sendToWorker

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

setDefaultTaskFunction

setDefaultTaskFunction(name): Promise<boolean>
+
Sets the default task function in this pool.
+
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function.
  +
  +
+
Returns Promise<boolean>
true if the default task function was set, false otherwise.
+ +
+
Inherited from AbstractPool.setDefaultTaskFunction
+
- Defined in src/pools/abstract-pool.ts:859

setTasksQueueOptions

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

setWorkerChoiceStrategy

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

setWorkerChoiceStrategyOptions

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

`Protected` setupHook

`Protected` workerListener

workerListener(): ((message) => void)
Defined in src/pools/abstract-pool.ts:998

start

start(): void
-
This method is the listener registered for each worker message.
+
Starts the minimum number of workers in this pool.

-
Returns ((message) => void)
The listener function to execute when a message is received from a worker.
- -
- -
  - (message): void

`Protected` workerMessageListener

workerMessageListener(message): void
-
This method is the listener registered for each worker message.
+
This method is the message listener registered on each worker.
Parameters
- message: MessageValue<Response, unknown>
-
Returns void
The listener function to execute when a message is received from a worker.
- -

Returns void

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

start

workerMessageListener

Generated using TypeDoc

\ No newline at end of file +

\ No newline at end of file

Parameters

message: MessageValue<Message, unknown>

Returns void

Parameters

message: MessageValue<Message, unknown>

Returns void