FixedClusterPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedClusterPool.html;h=2955f106307ee1d2a91a2a866401ba734088a841;hb=761b0c73be0bf581f50a78123913f933bd405f52;hp=c01b7c9ed62d788ed7cc1b0d578e249e68479ff5;hpb=8bd0b5363ad2defbce7c1cc49e616c24ad135dde;p=poolifier.git diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index c01b7c9e..2955f106 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,4 +1,4 @@ -FixedClusterPool | poolifier

+FixedClusterPool | poolifier

Response = unknown

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

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

@@ -58,41 +58,40 @@

Properties

emitter? filePath -nextMessageId numberOfWorkers opts -promiseMap +promiseResponseMap workerChoiceStrategyContext -workers -workersTasksUsage +workerNodes

Accessors

busy -numberOfRunningTasks +

busy +full +numberOfQueuedTasks +numberOfRunningTasks type

@@ -101,7 +100,7 @@

constructor

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

@@ -127,351 +126,352 @@
opts: ClusterPoolOptions = {}

Options for this fixed cluster pool.

Returns FixedClusterPool<Data, Response>

Properties

`Optional` `Readonly` emitter

emitter?: PoolEmitter

{@inheritDoc}

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.

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

`Readonly` filePath

filePath: string

Path to the worker-file.

`Protected` nextMessageId

nextMessageId: number = 0

Id of the next message.

Path to the worker file.

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

`Readonly` numberOfWorkers

numberOfWorkers: number

Number of workers that this pool should manage.

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

`Readonly` opts

opts: ClusterPoolOptions = {}

Options for this fixed cluster pool.

`Protected` promiseMap

promiseMap: Map<number, PromiseWorkerResponseWrapper<Worker, Response>> = ...

The promise map.

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

`Protected` promiseResponseMap

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

The execution response promise map.

key: This is the message Id of each submitted task.
value: An object that contains the worker, the resolve function and the reject function.
key: The message id of each submitted task.
value: An object that contains the worker, the execution response promise resolve and reject callbacks.

When we receive a message from the worker we get a map entry and resolve/reject the promise based on the message.

When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.

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

`Protected` workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

Worker choice strategy instance implementing the worker choice algorithm.

Default to a strategy implementing a round robin algorithm.

`Readonly` workers

workers: Worker[] = []

{@inheritDoc}

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

Worker choice strategy context referencing a worker choice algorithm implementation.

Default to a round robin algorithm.

`Readonly` workersTasksUsage

workersTasksUsage: Map<Worker, TasksUsage> = ...

{@inheritDoc}

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

`Readonly` workerNodes

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

Pool worker nodes.

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

Accessors

busy

`Protected` busy

get busy(): boolean
-
{@inheritDoc}
+
Whether the pool is busy or not.
+
The pool busyness boolean status.

Returns boolean
Overrides AbstractPool.busy
- Defined in src/pools/cluster/fixed.ts:104

numberOfRunningTasks

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

`Protected` full

get full(): boolean
+
Whether the pool is full or not.
+
The pool filling boolean status.
+
+
Returns boolean
+
Overrides AbstractPool.full
+
- Defined in src/pools/cluster/fixed.ts:104

`Private` numberOfQueuedTasks

get numberOfQueuedTasks(): number
+
Number of tasks queued in the pool.
+
+
Returns number
+
Inherited from AbstractPool.numberOfQueuedTasks
+
- Defined in src/pools/abstract-pool.ts:195

`Private` numberOfRunningTasks

get numberOfRunningTasks(): number
-
{@inheritDoc}
+
Number of tasks running in the pool.

Returns number
Inherited from AbstractPool.numberOfRunningTasks
- Defined in src/pools/abstract-pool.ts:151

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

type

get type(): PoolType
get type(): PoolType
-
{@inheritDoc}
+
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` afterPromiseWorkerResponseHook

`Protected` afterTaskExecutionHook

afterPromiseWorkerResponseHook(message: MessageValue<Response, unknown>, promise: PromiseWorkerResponseWrapper<Worker, Response>): void
afterTaskExecutionHook(worker: Worker, message: MessageValue<Response, unknown>): void
-
Hook executed after the worker task promise resolution. +
Hook executed after the worker task execution. Can be overridden.
Parameters
- -
  message: MessageValue<Response, unknown>
  -
  The received message.
  +
  worker: Worker
  +
  The worker.
- -
  promise: PromiseWorkerResponseWrapper<Worker, Response>
  -
  The Promise response.
  +
  message: MessageValue<Response, unknown>
  +
  The received message.
Returns void
-
Inherited from AbstractPool.afterPromiseWorkerResponseHook
+
Inherited from AbstractPool.afterTaskExecutionHook
- Defined in src/pools/abstract-pool.ts:266

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

`Protected` afterWorkerSetup

afterWorkerSetup(worker: Worker): void
-
{@inheritDoc}
+
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.
Parameters
- -
  worker: Worker
+
worker: Worker
+
The newly created worker.
+

Returns void

`Protected` beforePromiseWorkerResponseHook

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

`Protected` beforeTaskExecutionHook

beforePromiseWorkerResponseHook(worker: Worker): void
beforeTaskExecutionHook(workerNodeKey: number): void
-
Hook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
Parameters
- -
  worker: Worker
  -
  The worker.
  +
  workerNodeKey: number
  +
  The worker node key.
Returns void
-
Inherited from AbstractPool.beforePromiseWorkerResponseHook
+
Inherited from AbstractPool.beforeTaskExecutionHook
- Defined in src/pools/abstract-pool.ts:255

`Protected` chooseWorker

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

`Protected` chooseWorkerNode

chooseWorker(): Worker
chooseWorkerNode(): [number, WorkerNode<Worker, Data>]
-
Chooses a worker for the next task.
-
The default implementation uses a round robin algorithm to distribute the load.
+
Chooses a worker node for the next task.
+
The default uses a round robin algorithm to distribute the load.
-
Returns
Worker.
+
Returns
[worker node key, worker node].

-
Returns Worker
-
Inherited from AbstractPool.chooseWorker
+
Returns [number, WorkerNode<Worker, Data>]
+
Inherited from AbstractPool.chooseWorkerNode
- Defined in src/pools/abstract-pool.ts:293

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

`Protected` createAndSetupWorker

createAndSetupWorker(): Worker
-
Creates a new worker for this pool and sets it up completely.
+
Creates a new worker and sets it up completely in the pool worker nodes.

Returns
New, completely set up worker.

Returns Worker
-
Inherited from AbstractPool.createAndSetupWorker
+
Inherited from AbstractPool.createAndSetupWorker
- Defined in src/pools/abstract-pool.ts:337

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

`Protected` createWorker

createWorker(): Worker
-
{@inheritDoc}
+
Returns a newly created worker.

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

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

destroy

destroy(): Promise<void>
-
{@inheritDoc}
+
Shutdowns every current worker in this pool.

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

destroyWorker

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

`Protected` destroyWorker

destroyWorker(worker: Worker): void
-
{@inheritDoc}
+
Shutdowns the given worker.
Parameters
- -
  worker: Worker
+
worker: Worker
+
A worker within workerNodes.
+

Returns void

execute

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

enableTasksQueue

execute(data: Data): Promise<Response>
enableTasksQueue(enable: boolean, tasksQueueOptions?: TasksQueueOptions): void
-
{@inheritDoc}
+
Enables/disables the worker tasks queue in this pool.
Parameters
- -
  data: Data
-
Returns Promise<Response>
-
Inherited from AbstractPool.execute
-
- Defined in src/pools/abstract-pool.ts:205

findFreeWorker

findFreeWorker(): false | Worker
-
{@inheritDoc}
-
-
Returns false | Worker
-
Inherited from AbstractPool.findFreeWorker
-
- Defined in src/pools/abstract-pool.ts:194

getWorkerAverageTasksRunTime

getWorkerAverageTasksRunTime(worker: Worker): undefined | number
-
{@inheritDoc}
-
-
-
Parameters
-
- -
  worker: Worker
-
Returns undefined | number
-
Inherited from AbstractPool.getWorkerAverageTasksRunTime
+
Optional tasksQueueOptions: TasksQueueOptions
+
The worker tasks queue options.
+

Returns void

getWorkerIndex

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

execute

getWorkerIndex(worker: Worker): number
execute(data?: Data): Promise<Response>
-
{@inheritDoc}
+
Executes the function specified in the worker constructor with the task data input parameter.
+ +
Returns
Promise that will be fulfilled when the task is completed.
Parameters
- -
  worker: Worker
-
Returns number
-
Inherited from AbstractPool.getWorkerIndex
+
Optional data: Data
+
The task input data for the specified worker function. This can only be serializable data.
+

Returns Promise<Response>

getWorkerRunningTasks

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

findFreeWorkerNodeKey

getWorkerRunningTasks(worker: Worker): undefined | number
findFreeWorkerNodeKey(): number
-
{@inheritDoc}
+
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.

-
-
Parameters
-
- -
  worker: Worker
-
Returns undefined | number
-
Inherited from AbstractPool.getWorkerRunningTasks
+
Returns number
+
Inherited from AbstractPool.findFreeWorkerNodeKey
- Defined in src/pools/abstract-pool.ts:161

`Protected` internalGetBusyStatus

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

`Protected` internalBusy

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

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

`Protected` isMain

isMain(): boolean
-
{@inheritDoc}
+
Should return whether the worker is the main worker or not.

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

registerWorkerMessageListener

registerWorkerMessageListener<Message>(worker: Worker, listener: ((message: MessageValue<Message, unknown>) => void)): void
Defined in src/pools/cluster/fixed.ts:64

`Protected` registerWorkerMessageListener

registerWorkerMessageListener<Message>(worker: Worker, listener: ((message: MessageValue<Message, unknown>) => void)): void
-
{@inheritDoc}
+
Registers a listener callback on the given worker.
Type Parameters
@@ -482,103 +482,136 @@ Can be overridden.

Parameters
- -
  worker: Worker
- -
  listener: ((message: MessageValue<Message, unknown>) => void)
  +
  listener: ((message: MessageValue<Message, unknown>) => void)
  +
  The message listener callback.
  +
  - -
    (message: MessageValue<Message, unknown>): void
    +
    (message: MessageValue<Message, unknown>): void
    
    Parameters
    
    -
    message: MessageValue<Message, unknown>
    +
    message: MessageValue<Message, unknown>
Returns void

Returns void

`Protected` removeWorker

removeWorker(worker: Worker): void
Defined in src/pools/cluster/fixed.ts:80

`Protected` sendToWorker

sendToWorker(worker: Worker, message: MessageValue<Data, unknown>): void
-
Removes the given worker from the pool.
+
Sends a message to the given worker.
Parameters
- worker: Worker
  -
  The worker that will be removed.
  +
  The worker which should receive the message.
  +
- +
  message: MessageValue<Data, unknown>
  +
  The message.
Returns void
-
Inherited from AbstractPool.removeWorker
+
Overrides AbstractPool.sendToWorker
- Defined in src/pools/abstract-pool.ts:280

`Protected` sendToWorker

sendToWorker(worker: Worker, message: MessageValue<Data, unknown>): void
Defined in src/pools/cluster/fixed.ts:75

setTasksQueueOptions

setTasksQueueOptions(tasksQueueOptions: TasksQueueOptions): void
-
{@inheritDoc}
+
Sets the worker tasks queue options in this pool.
Parameters
- -
  worker: Worker
- -
  message: MessageValue<Data, unknown>
+
tasksQueueOptions: TasksQueueOptions
+
The worker tasks queue options.
+

Returns void

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

setWorkerChoiceStrategy

setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN", workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions): void
+
Sets the worker choice strategy in this pool.
+
+
+
Parameters
+
- +
  workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "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:218

setWorkerChoiceStrategyOptions

setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions: WorkerChoiceStrategyOptions): void
-
{@inheritDoc}
+
Sets the worker choice strategy options in this pool.
Parameters
- -
  workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+
workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
+
The worker choice strategy options.
+

Returns void

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

`Protected` setupHook

setupHook(): void
-
{@inheritDoc}
+
Setup hook to execute code before worker node are created in the abstract constructor. +Can be overridden

Returns void
-
Overrides AbstractPool.setupHook
+
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: MessageValue<Response, unknown>) => void)
-
This function is the listener registered for each worker.
+
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: MessageValue<Response, unknown>) => void)
- - (message: MessageValue<Response, unknown>): void
  - (message: MessageValue<Response, unknown>): void
  - -
    This function is the listener registered for each worker.
    +
    This function is the listener registered for each worker message.
    
    Returns
    The listener function to execute when a message is received from a worker.
    
    @@ -586,15 +619,16 @@ Can be overridden.
    
    Parameters
    
    -
    message: MessageValue<Response, unknown>
    +
    message: MessageValue<Response, unknown>
Returns void

- + - + +

Generated using TypeDoc

\ No newline at end of file +

\ No newline at end of file

Properties

Returns boolean

Returns number

Parameters

message: MessageValue<Response, unknown>

worker: Worker

promise: PromiseWorkerResponseWrapper<Worker, Response>

message: MessageValue<Response, unknown>

Returns void

Parameters

worker: Worker

worker: Worker

worker: Worker

workerNodeKey: number

worker: Worker

data: Data

worker: Worker

worker: Worker

worker: Worker

worker: Worker

worker: Worker

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

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

Parameters

message: MessageValue<Message, unknown>

message: MessageValue<Message, unknown>

worker: Worker

message: MessageValue<Data, unknown>

worker: Worker

message: MessageValue<Data, unknown>

workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

`Optional` workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"

Returns

Parameters

message: MessageValue<Response, unknown>

message: MessageValue<Response, unknown>

Member Visibility

Theme