FixedClusterPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=a7d9826725e5f8c2d8f55dc3f07f69ab2112ee66;hb=70353024c44987c467dadcec306c699ce4ae1f06;hp=2249ac0fad1a469ad625069665fcd1df448062da;hpb=7e36fa9f0f844e3e60f0c22de3e28665dd8cc9d1;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 2249ac0f..a7d98267 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier

+FixedClusterPool | poolifier

@@ -24,27 +24,27 @@

Since

2.0.0

Type Parameters

-
Data = unknown
+
Data = unknown

Type of data sent to the worker. This can only be serializable data.
-
Response = unknown
+
Response = unknown

Type of execution response. This can only be serializable data.

Hierarchy

AbstractPool<Worker, Data, Response> +
AbstractPool<Worker, Data, Response>
- FixedClusterPool
  - DynamicClusterPool

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

@@ -52,123 +52,127 @@

Constructors

constructor

new FixedClusterPool<Data, Response>(numberOfWorkers: number, filePath: string, opts?: ClusterPoolOptions): FixedClusterPool<Data, Response>

new FixedClusterPool<Data, Response>(numberOfWorkers, filePath, opts?): FixedClusterPool<Data, Response>
Constructs a new poolifier fixed cluster pool.

-
+
Type Parameters
-
+
Response = unknown

Parameters

-
numberOfWorkers: number
+
numberOfWorkers: number

Number of workers for this pool.
-
filePath: string
+
filePath: string

Path to an implementation of a ClusterWorker file, which can be relative or absolute.
-
opts: ClusterPoolOptions = {}
+
opts: ClusterPoolOptions = {}

Options for this fixed cluster pool.

Returns FixedClusterPool<Data, Response>

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

Properties

`Optional` `Readonly` emitter

emitter?: PoolEmitter

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.
'error': Emitted when an error occurs.

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

`Readonly` filePath

filePath: string

Path to the worker-file.

filePath: string

Path to the worker file.

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

`Readonly` numberOfWorkers

numberOfWorkers: number

Number of workers that this pool should manage.

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

`Readonly` opts

opts: ClusterPoolOptions = {}

Options for this fixed cluster pool.

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

`Protected` promiseResponseMap

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

`Protected` workerChoiceStrategyContext

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

`Readonly` workerNodes

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

Pool worker nodes.

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

Accessors

`Protected` busy

get busy(): boolean
Whether the pool is busy or not.
@@ -209,10 +213,10 @@
Returns boolean
Overrides AbstractPool.busy
- Defined in src/pools/cluster/fixed.ts:109

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

`Protected` full

get full(): boolean
Whether the pool is full or not.
@@ -221,10 +225,10 @@
Returns boolean
Overrides AbstractPool.full
- Defined in src/pools/cluster/fixed.ts:104

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

`Private` numberOfQueuedTasks

get numberOfQueuedTasks(): number
Number of tasks queued in the pool.
@@ -232,10 +236,10 @@
Returns number
Inherited from AbstractPool.numberOfQueuedTasks
- Defined in src/pools/abstract-pool.ts:186

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

`Private` numberOfRunningTasks

get numberOfRunningTasks(): number
Number of tasks running in the pool.
@@ -243,25 +247,36 @@
Returns number
Inherited from AbstractPool.numberOfRunningTasks
- Defined in src/pools/abstract-pool.ts:176

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

size

get size(): number
+
Pool maximum size.
+
+
Returns number
+
Overrides AbstractPool.size
+
- Defined in src/pools/cluster/fixed.ts:104

type

get type(): PoolType

get type(): PoolType
Pool type.

If it is 'dynamic', it provides the max property.

-
Returns PoolType
+
Returns PoolType
Overrides AbstractPool.type
- Defined in src/pools/cluster/fixed.ts:99

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

Methods

`Protected` afterTaskExecutionHook

afterTaskExecutionHook(worker: Worker, message: MessageValue<Response, unknown>): void

afterTaskExecutionHook(worker, message): void
Hook executed after the worker task execution. Can be overridden.
@@ -270,21 +285,21 @@ Can be overridden.

Parameters
- -
  worker: Worker
  +
  worker: Worker
  
  The worker.
- -
  message: MessageValue<Response, unknown>
  +
  message: MessageValue<Response, Worker | MessagePort>
  
  The received message.
Returns void
Inherited from AbstractPool.afterTaskExecutionHook
- Defined in src/pools/abstract-pool.ts:335

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

`Protected` afterWorkerSetup

afterWorkerSetup(worker: Worker): void

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.
@@ -293,17 +308,17 @@ Can be overridden.

Parameters
- -
  worker: Worker
  +
  worker: Worker
  
  The newly created worker.
Returns void
Overrides AbstractPool.afterWorkerSetup
- Defined in src/pools/cluster/fixed.ts:93

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

`Protected` beforeTaskExecutionHook

beforeTaskExecutionHook(workerNodeKey: number): void

beforeTaskExecutionHook(workerNodeKey): void
Hook executed before the worker task execution. Can be overridden.
@@ -312,66 +327,64 @@ Can be overridden.

Parameters
- -
  workerNodeKey: number
  +
  workerNodeKey: number
  
  The worker node key.
Returns void
Inherited from AbstractPool.beforeTaskExecutionHook
- Defined in src/pools/abstract-pool.ts:324

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

`Protected` chooseWorkerNode

chooseWorkerNode(): [number, WorkerNode<Worker, Data>]

chooseWorkerNode(): number
Chooses a worker node for the next task.
-
The default uses a round robin algorithm to distribute the load.
- -
Returns
[worker node key, worker node].
+
The default worker choice strategy uses a round robin algorithm to distribute the load.

-
Returns [number, WorkerNode<Worker, Data>]
+
Returns number
The worker node key
+
Inherited from AbstractPool.chooseWorkerNode
- Defined in src/pools/abstract-pool.ts:368

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

`Protected` createAndSetupWorker

createAndSetupWorker(): Worker

createAndSetupWorker(): Worker
Creates a new worker and sets it up completely in the pool worker nodes.
- -
Returns
New, completely set up worker.

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

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

`Protected` createWorker

createWorker(): Worker

createWorker(): Worker
Returns a newly created worker.

-
Returns Worker
+
Returns Worker
Overrides AbstractPool.createWorker
- Defined in src/pools/cluster/fixed.ts:88

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

destroy

destroy(): Promise<void>

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

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

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

`Protected` destroyWorker

destroyWorker(worker: Worker): void

destroyWorker(worker): void
Shutdowns the given worker.

@@ -379,110 +392,120 @@ Can be overridden.

Parameters
- -
  worker: Worker
  +
  worker: Worker
  
  A worker within workerNodes.

Returns void

execute

execute(data: Data): Promise<Response>
Defined in src/pools/cluster/fixed.ts:69

enableTasksQueue

enableTasksQueue(enable, tasksQueueOptions?): void
-
Performs the task specified in the constructor with the data parameter.
- -
Returns
Promise that will be resolved when the task is successfully completed.
+
Enables/disables the worker tasks queue in this pool.
Parameters
- -
  data: Data
  -
  The input for the specified task. This can only be serializable data.
  +
  enable: boolean
  +
  Whether to enable or disable the worker tasks queue.
  +
- +
  Optional tasksQueueOptions: TasksQueueOptions
  +
  The worker tasks queue options.
-
Returns Promise<Response>
-
Inherited from AbstractPool.execute
+
Returns void
+
Inherited from AbstractPool.enableTasksQueue
- Defined in src/pools/abstract-pool.ts:256

findFreeWorkerNodeKey

findFreeWorkerNodeKey(): number
Defined in src/pools/abstract-pool.ts:294

execute

execute(data?, name?): Promise<Response>
-
Finds a free worker node key based on the number of tasks the worker has applied.
-
If a worker is found with 0 running tasks, it is detected as free and its worker node key is returned.
-
If no free worker is found, -1 is returned.
- -
Returns
A worker node key if there is one, -1 otherwise.
+
Executes the specified function in the worker constructor with the task data input parameter.

-
Returns number
-
Inherited from AbstractPool.findFreeWorkerNodeKey
+
+
Parameters
+
- +
  Optional data: Data
  +
  The task input data for the specified worker function. This can only be serializable data.
  +
- +
  Optional name: string
  +
  The name of the worker function to execute. If not specified, the default worker function will be executed.
  +
+
Returns Promise<Response>
Promise that will be fulfilled when the task is completed.
+
+
Inherited from AbstractPool.execute
- Defined in src/pools/abstract-pool.ts:249

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

`Protected` internalBusy

internalBusy(): boolean

internalBusy(): boolean
Returns boolean
Inherited from AbstractPool.internalBusy
- Defined in src/pools/abstract-pool.ts:244

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

`Protected` isMain

isMain(): boolean

isMain(): boolean
Should return whether the worker is the main worker or not.

Returns boolean
Overrides AbstractPool.isMain
- Defined in src/pools/cluster/fixed.ts:64

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

`Protected` registerWorkerMessageListener

registerWorkerMessageListener<Message>(worker: Worker, listener: ((message: MessageValue<Message, unknown>) => void)): void

registerWorkerMessageListener<Message>(worker, listener): void
Registers a listener callback on the given worker.

-
+
Type Parameters
-
+
Message

Parameters

-
worker: Worker
+
worker: Worker

The worker which should register a listener.
-
listener: ((message: MessageValue<Message, unknown>) => void)
+
listener: ((message) => void)

The message listener callback.
- -
  - (message: MessageValue<Message, unknown>): void

Returns void

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

`Protected` sendToWorker

sendToWorker(worker: Worker, message: MessageValue<Data, unknown>): void

sendToWorker(worker, message): void
Sends a message to the given worker.

@@ -490,21 +513,39 @@ Can be overridden.

Parameters
- -
  worker: Worker
  +
  worker: Worker
  
  The worker which should receive the message.
- -
  message: MessageValue<Data, unknown>
  +
  message: MessageValue<Data, Worker | MessagePort>
  
  The message.
Returns void
Overrides AbstractPool.sendToWorker
- Defined in src/pools/cluster/fixed.ts:75

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

setTasksQueueOptions

setTasksQueueOptions(tasksQueueOptions): void
+
Sets the worker tasks queue options in this pool.
+
+
+
Parameters
+
- +
  tasksQueueOptions: TasksQueueOptions
  +
  The worker tasks queue options.
  +
+
Returns void
+
Inherited from AbstractPool.setTasksQueueOptions
+
- Defined in src/pools/abstract-pool.ts:306

setWorkerChoiceStrategy

setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void

setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void
Sets the worker choice strategy in this pool.

@@ -512,17 +553,39 @@ Can be overridden.

Parameters
- -
  workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
  +
  workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
  
  The worker choice strategy.
  +
- +
  Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
  +
  The worker choice strategy options.
Returns void
Inherited from AbstractPool.setWorkerChoiceStrategy
- Defined in src/pools/abstract-pool.ts:209

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

setWorkerChoiceStrategyOptions

setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void
+
Sets the worker choice strategy options in this pool.
+
+
+
Parameters
+
- +
  workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
  +
  The worker choice strategy options.
  +
+
Returns void
+
Inherited from AbstractPool.setWorkerChoiceStrategyOptions
+
- Defined in src/pools/abstract-pool.ts:283

`Protected` setupHook

setupHook(): void

setupHook(): void
Setup hook to execute code before worker node are created in the abstract constructor. Can be overridden
@@ -530,35 +593,33 @@ Can be overridden

Returns void
Overrides AbstractPool.setupHook
- Defined in src/pools/cluster/fixed.ts:59

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

`Protected` workerListener

workerListener(): ((message: MessageValue<Response, unknown>) => void)

workerListener(): ((message) => void)
This function is the listener registered for each worker message.
- -
Returns
The listener function to execute when a message is received from a worker.

-
Returns ((message: MessageValue<Response, unknown>) => void)
+
Returns ((message) => void)
The listener function to execute when a message is received from a worker.
+
- -
  - (message: MessageValue<Response, unknown>): void
  +
  message: MessageValue<Response, Worker | MessagePort>
+
Returns void
The listener function to execute when a message is received from a worker.
+