FixedClusterPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=e08646bd66302ae6417e204ddf1513408f052974;hb=7ef6859d79e3a30918f2c53c898e94cd22104622;hp=3c06ec2642e78afc09fa51d4a8240e0980269e52;hpb=4608939f425568da5553db1f5bf883d4cca18e02;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 3c06ec26..e08646bd 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier - v2.6.45

+FixedClusterPool | poolifier - v3.0.0

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

DynamicClusterPool

Defined in src/pools/cluster/fixed.ts:33

@@ -80,33 +80,38 @@

Constructors

@@ -146,13 +151,14 @@

Defined in src/pools/cluster/fixed.ts:44

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

`Protected` `Readonly` filePath

filePath: string

@@ -176,7 +182,7 @@

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

`Protected` `Optional` `Readonly` max

max?: number

@@ -185,7 +191,7 @@

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

`Protected` `Readonly` numberOfWorkers

numberOfWorkers: number

@@ -194,7 +200,7 @@

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

`Protected` `Readonly` opts

opts: ClusterPoolOptions = {}

@@ -203,7 +209,7 @@

Defined in src/pools/cluster/fixed.ts:47

`Protected` promiseResponseMap

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

@@ -217,7 +223,7 @@

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

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

@@ -226,7 +232,7 @@

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

`Readonly` `Internal` workerNodes

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

@@ -235,7 +241,7 @@

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

Accessors

@@ -250,7 +256,7 @@

Defined in src/pools/cluster/fixed.ts:139

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

`Protected` afterTaskExecutionHook

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

`Protected` afterWorkerNodeSetup

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

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

`Protected` createAndSetupDynamicWorkerNode

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

`Protected` createAndSetupWorkerNode

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

`Protected` createWorker

Defined in src/pools/cluster/fixed.ts:124

`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/cluster/fixed.ts:116

destroy

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

`Protected` destroyWorkerNode

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

enableTasksQueue

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

execute

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

`Protected` flushTasksQueue

Returns void

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

`Protected` getWorkerInfo

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

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

hasWorkerNodeBackPressure

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

`Protected` internalBusy

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

`Protected` isMain

listTaskFunctions

Defined in src/pools/cluster/fixed.ts:58

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

`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/abstract-pool.ts:712

Defined in src/pools/cluster/fixed.ts:108

`Protected` registerWorkerMessageListener

Defined in src/pools/cluster/fixed.ts:100

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

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

`Protected` sendStartupMessageToWorker

Defined in src/pools/cluster/fixed.ts:93

`Protected` sendToWorker

Defined in src/pools/cluster/fixed.ts:82

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

setTasksQueueOptions

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

setWorkerChoiceStrategy

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

setWorkerChoiceStrategyOptions

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

`Protected` setupHook

Defined in src/pools/cluster/fixed.ts:53

start

`Protected` workerListener

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

`Protected` workerMessageListener

workerListener(): ((message) => void)
workerMessageListener(message): void
-
This method is the listener registered for each worker message.
-
-
Returns ((message) => void)
The listener function to execute when a message is received from a worker.
- -
- -
  - (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
-
Inherited from AbstractPool.workerListener
+
Inherited from AbstractPool.workerMessageListener
- Defined in src/pools/abstract-pool.ts:1326

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

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

Parameters

message: MessageValue<Response, unknown>

Returns void