X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FDynamicClusterPool.html;h=53242a4961ac606d00edf78b736aea361a0beb91;hb=938d9c678aa8e70e5642feffb90604cf25c993fe;hp=09bddee613cddcf688eac0525f44ba4128bb51e8;hpb=79458fb6e10234a237757111e710f8f71424fa06;p=poolifier.git diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 09bddee6..53242a49 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,4 +1,4 @@ -
A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.
This cluster pool creates new workers when the others are busy, up to the maximum number of workers. -When the maximum number of workers is reached, an event is emitted. If you want to listen to this event, use the pool's
+When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool'semitter
.emitter
.Author
Christopher Quadflieg
@@ -28,21 +28,21 @@ When the maximum number of workers is reached, an event is emitted. If you wantType Parameters
Data = unknown
+Data = unknown
Type of data sent to the worker. This can only be serializable data.
Response = unknown
-Type of response of execution. This can only be serializable data.
+Response = unknown
+Type of execution response. This can only be serializable data.
Hierarchy
-- FixedClusterPool<Data, Response>
+
- FixedClusterPool<Data, Response>
- DynamicClusterPool
@@ -50,52 +50,55 @@ When the maximum number of workers is reached, an event is emitted. If you want
constructor
+constructor
emitter?
-file Path
-max
-number Of Workers
-opts
-promise Response Map
-worker Choice Strategy Context
-workers
+emitter?
+file Path
+max
+number Of Workers
+opts
+promise Response Map
+worker Choice Strategy Context
+worker Nodes
busy
-number Of Running Tasks
-type
+busy
+full
+number Of Queued Tasks
+number Of Running Tasks
+type
after Promise Response Hook
-after Worker Setup
-before Promise Response Hook
-choose Worker
-create And Setup Worker
-create Worker
-destroy
-destroy Worker
-execute
-find Free Worker Key
-internal Get Busy Status
-is Main
-register Worker Message Listener
-remove Worker
-send To Worker
-set Worker Choice Strategy
-setup Hook
-worker Listener
+after Task Execution Hook
+after Worker Setup
+before Task Execution Hook
+choose Worker Node
+create And Setup Worker
+create Worker
+destroy
+destroy Worker
+enable Tasks Queue
+execute
+internal Busy
+is Main
+register Worker Message Listener
+send To Worker
+set Tasks Queue Options
+set Worker Choice Strategy
+set Worker Choice Strategy Options
+setup Hook
+worker Listener
+
+
-
-
-
-
-
-
-
-
-
+- Defined in src/pools/cluster/dynamic.ts:28
+
emitter?: PoolEmitter
-emitter?: PoolEmitter
+
-
+- Defined in src/pools/abstract-pool.ts:42
+
file Path: string
-file Path: string
+
-
-max: number
+- Defined in src/pools/abstract-pool.ts:77
+
+max: number
-
+- Defined in src/pools/cluster/dynamic.ts:30
+
number Of Workers: number
+number Of Workers: number
-
+- Defined in src/pools/abstract-pool.ts:76
+
opts: ClusterPoolOptions = {}
+opts: ClusterPoolOptions = {}
-
+- Defined in src/pools/cluster/fixed.ts:53
+
promise Response Map: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
-promise Response Map: Map<string, PromiseResponseWrapper<Worker, Response>> = ...
+
-
+
-
-
+- Defined in src/pools/abstract-pool.ts:52
+
worker Choice Strategy Context: WorkerChoiceStrategyContext<Worker, Data, Response>
-worker Choice Strategy Context: WorkerChoiceStrategyContext<Worker, Data, Response>
+
-
-workers: WorkerType<Worker>[] = []
-- Defined in src/pools/abstract-pool.ts:62
+
+worker Nodes: WorkerNode<Worker, Data>[] = []
+
-
+- Defined in src/pools/abstract-pool.ts:39
-
Constructors
-Properties
-Accessors
-Methods
-Constructors
-constructor
--- new
Dynamic Cluster Pool<Data, Response>(min: number, max: number, filePath: string, opts?: ClusterPoolOptions): DynamicClusterPool<Data, Response>
+
+- new
Dynamic Cluster Pool<Data, Response>(min, max, filePath, opts?): DynamicClusterPool<Data, Response>
-
@@ -103,423 +106,506 @@ When the maximum number of workers is reached, an event is emitted. If you want
-
-
+
-
-
Constructs a new poolifier dynamic cluster pool.
Type Parameters
Data = unknown
Data = unknown
Response = unknown
Response = unknown
Parameters
min: number
+min: number
Minimum number of workers which are always active.
max: number
+max: number
Maximum number of workers that can be created by 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 dynamic cluster pool.
Returns DynamicClusterPool<Data, Response>
Properties
-
-Optional
Readonly
emitter{@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.Inherited from FixedClusterPool.emitter
-- Defined in src/pools/abstract-pool.ts:32
Path
-Readonly
filePath to the worker-file.
+Path to the worker file.
Inherited from FixedClusterPool.filePath
-- Defined in src/pools/abstract-pool.ts:67
-Protected
Readonly
max
+Readonly
maxMaximum number of workers that can be created by this pool.
-- Defined in src/pools/cluster/dynamic.ts:30
Of Workers
-Readonly
numberNumber of workers that this pool should manage.
Inherited from FixedClusterPool.numberOfWorkers
-- Defined in src/pools/abstract-pool.ts:66
-Readonly
optsOptions for this fixed cluster pool.
Inherited from FixedClusterPool.opts
-- Defined in src/pools/cluster/fixed.ts:53
Response Map
-Protected
promiseThe promise response map.
+The execution response promise map.
key
: The message id of each submitted task.value
: An object that contains the worker, the promise resolve and reject callbacks.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 with the promise resolve/reject bound to 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.
Inherited from FixedClusterPool.promiseResponseMap
-- Defined in src/pools/abstract-pool.ts:42
Choice Strategy Context
-Protected
workerWorker choice strategy instance implementing the worker choice algorithm.
-Default to a strategy implementing a round robin algorithm.
+Worker choice strategy context referencing a worker choice algorithm implementation.
+Default to a round robin algorithm.
Inherited from FixedClusterPool.workerChoiceStrategyContext
-- Defined in src/pools/abstract-pool.ts:52
-Readonly
workers{@inheritDoc}
+ Nodes
+Readonly
workerPool worker nodes.
Inherited from FixedClusterPool.workers
+Inherited from FixedClusterPool.workerNodes
-- Defined in src/pools/abstract-pool.ts:29
Accessors
-busy
-+
+- get busy(): boolean
-
-
-
-
+
+
+
+
+
+- get numberOfRunningTasks(): number
-
-
-
+- Defined in src/pools/abstract-pool.ts:185
+
+Protected
busy{@inheritDoc}
+Whether the pool is busy or not.
+The pool busyness boolean status.
Returns boolean
Overrides FixedClusterPool.busy
-- Defined in src/pools/cluster/dynamic.ts:43
number Of Running Tasks
-+- Defined in src/pools/cluster/dynamic.ts:48
+Protected
full+- get full(): boolean
+-
+
+
+
Whether the pool is full or not.
+The pool filling boolean status.
+Returns boolean
Overrides FixedClusterPool.full
++- Defined in src/pools/cluster/dynamic.ts:43
Of Queued Tasks
+Private
number+- get numberOfQueuedTasks(): number
+-
+
+
+
Number of tasks queued in the pool.
+Returns number
Inherited from FixedClusterPool.numberOfQueuedTasks
++- Defined in src/pools/abstract-pool.ts:195
Of Running Tasks
+Private
number{@inheritDoc}
+Number of tasks running in the pool.
Returns number
Inherited from FixedClusterPool.numberOfRunningTasks
-- Defined in src/pools/abstract-pool.ts:141
type
--- get type(): PoolType
+
+- get type(): PoolType
-
-
-
+
+- Defined in src/pools/cluster/dynamic.ts:38
-
{@inheritDoc}
+Pool type.
+If it is
'dynamic'
, it provides themax
property.Returns PoolType
Returns PoolType
Overrides FixedClusterPool.type
-- Defined in src/pools/cluster/dynamic.ts:38
Methods
- Promise Response Hook
-Protected
after-- after
Promise Response Hook(worker: Worker, message: MessageValue<Response, unknown>): void
+
+
Task Execution Hook
+Protected
after+- after
Task Execution Hook(worker, message): void
-
-
-
-
-
-
-
-
+- Defined in src/pools/abstract-pool.ts:386
+
-
-
+
+
Hook executed after the worker task promise resolution. +
Hook executed after the worker task execution. Can be overridden.
Parameters
worker: Worker
+worker: Worker
The worker.
message: MessageValue<Response, unknown>
+message: MessageValue<Response, unknown>
The received message.
Returns void
Inherited from FixedClusterPool.afterPromiseResponseHook
+Inherited from FixedClusterPool.afterTaskExecutionHook
-- Defined in src/pools/abstract-pool.ts:253
Worker Setup
-Protected
after-- after
Worker Setup(worker: Worker): void
+
+- after
Worker Setup(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 themain-worker
<->worker
connection if not bind by default.Parameters
worker: Worker
worker: Worker
+The newly created worker.
+Returns void
Inherited from FixedClusterPool.afterWorkerSetup
-- Defined in src/pools/cluster/fixed.ts:93
Promise Response Hook
-Protected
before-- before
Promise Response Hook(workerKey: number): void
+- Defined in src/pools/cluster/fixed.ts:93
Task Execution Hook
+Protected
before+- before
Task Execution Hook(workerNodeKey): void
-
-
-
-
-
-
-
+
+
Hook executed before the worker task promise resolution. +
Hook executed before the worker task execution. Can be overridden.
Parameters
workerKey: number
-The worker key.
+workerNodeKey: number
+The worker node key.
Returns void
Inherited from FixedClusterPool.beforePromiseResponseHook
+Inherited from FixedClusterPool.beforeTaskExecutionHook
-- Defined in src/pools/abstract-pool.ts:242
Worker
-Protected
choose-- choose
Worker(): [number, Worker]
+- Defined in src/pools/abstract-pool.ts:375
Worker Node
+Protected
choose+- choose
Worker Node(): [number, WorkerNode<Worker, Data>]
-
-
-
-
+
-
+- Defined in src/pools/abstract-pool.ts:419
+
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 key, worker].
+Returns
[worker node key, worker node].
Returns [number, Worker]
Inherited from FixedClusterPool.chooseWorker
+Returns [number, WorkerNode<Worker, Data>]
Inherited from FixedClusterPool.chooseWorkerNode
-- Defined in src/pools/abstract-pool.ts:290
And Setup Worker
-Protected
create-- create
And Setup Worker(): Worker
+
+- create
And Setup Worker(): Worker
-
-
-
+
-
+- Defined in src/pools/abstract-pool.ts:481
+
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
Returns Worker
Inherited from FixedClusterPool.createAndSetupWorker
-- Defined in src/pools/abstract-pool.ts:335
Worker
-Protected
create-- create
Worker(): Worker
+
+- create
Worker(): Worker
-
-
-
+
-
+- Defined in src/pools/cluster/fixed.ts:88
+
+
-
\ No newline at end of file
+
\ No newline at end of file
{@inheritDoc}
+Returns a newly created worker.
Returns Worker
Returns Worker
Inherited from FixedClusterPool.createWorker
-- Defined in src/pools/cluster/fixed.ts:88
destroy
--- destroy(): Promise<void>
+
+- destroy(): Promise<void>
-
-
-
+
-
-
+
+
-
-
+
+
-
-
+
+
{@inheritDoc}
+Shutdowns every current worker in this pool.
Returns Promise<void>
Returns Promise<void>
Inherited from FixedClusterPool.destroy
-- Defined in src/pools/abstract-pool.ts:208
destroy Worker
--- destroy
Worker(worker: Worker): void
+- Defined in src/pools/abstract-pool.ts:338
Worker
+Protected
destroy+- destroy
Worker(worker): void
-
-
-
-
+
{@inheritDoc}
+Shutdowns the given worker.
Parameters
worker: Worker
worker: Worker
+A worker within
+workerNodes
.Returns void
Inherited from FixedClusterPool.destroyWorker
-- Defined in src/pools/cluster/fixed.ts:69
execute
--- execute(data: Data): Promise<Response>
+- Defined in src/pools/cluster/fixed.ts:69
enable Tasks Queue
++- enable
Tasks Queue(enable, tasksQueueOptions?): void
-
-
-
-
-
-
+-
+
+
+
{@inheritDoc}
+Enables/disables the worker tasks queue in this pool.
Parameters
data: Data
Returns Promise<Response>
Inherited from FixedClusterPool.execute
+enable: boolean
+Whether to enable or disable the worker tasks queue.
+
+Optional
tasksQueueOptions: TasksQueueOptionsThe worker tasks queue options.
+Returns void
Inherited from FixedClusterPool.enableTasksQueue
-- Defined in src/pools/abstract-pool.ts:193
find Free Worker Key
--- find
Free Worker Key(): number | false
+- Defined in src/pools/abstract-pool.ts:254
execute
++- execute(data?): Promise<Response>
-
-
-
-
-
-
+
+
-
+- Defined in src/pools/abstract-pool.ts:298
+
+
+
{@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.
Returns number | false
Inherited from FixedClusterPool.findFreeWorkerKey
--- Defined in src/pools/abstract-pool.ts:185
Get Busy Status
-Protected
internal-- internal
Get Busy Status(): boolean
+
+
+
+
Parameters
++-
+
+Optional
data: DataThe task input data for the specified worker function. This can only be serializable data.
+Returns Promise<Response>
Inherited from FixedClusterPool.execute
++- Defined in src/pools/abstract-pool.ts:307
Busy
+Protected
internal+- internal
Busy(): boolean
-
-
Returns boolean
Inherited from FixedClusterPool.internalGetBusyStatus
+Inherited from FixedClusterPool.internalBusy
-- Defined in src/pools/abstract-pool.ts:177
Main
-Protected
is-- is
Main(): boolean
+
+- is
Main(): boolean
-
-
-
-
+
+
-
-
+
+
-
+- constructor
+- emitter
+- file
Path
+- max
+- number
Of Workers
+- opts
+- promise
Response Map
+- worker
Choice Strategy Context
+- worker
Nodes
+- busy
+- full
+- number
Of Queued Tasks
+- number
Of Running Tasks
+- type
+- after
Task Execution Hook
+- after
Worker Setup
+- before
Task Execution Hook
+- choose
Worker Node
+- create
And Setup Worker
+- create
Worker
+- destroy
+- destroy
Worker
+- enable
Tasks Queue
+- execute
+- internal
Busy
+- is
Main
+- register
Worker Message Listener
+- send
To Worker
+- set
Tasks Queue Options
+- set
Worker Choice Strategy
+- set
Worker Choice Strategy Options
+- setup
Hook
+- worker
Listener
{@inheritDoc}
+Should return whether the worker is the main worker or not.
Returns boolean
Inherited from FixedClusterPool.isMain
-- Defined in src/pools/cluster/fixed.ts:64
register Worker Message Listener
--- register
Worker Message Listener<Message>(worker: Worker, listener: ((message: MessageValue<Message, unknown>) => void)): void
+- Defined in src/pools/cluster/fixed.ts:64
Worker Message Listener
+Protected
register+- register
Worker Message Listener<Message>(worker, listener): void
-
-
-
-
+
-
-
+
-
-
-
-
{@inheritDoc}
+Registers a listener callback on the given worker.
Type Parameters
Message
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
+
+- (message): void
-
-
-
+
Parameters
message: MessageValue<Message, unknown>
message: MessageValue<Message, unknown>
Returns void
Returns void
Inherited from FixedClusterPool.registerWorkerMessageListener
-- Defined in src/pools/cluster/fixed.ts:80
Worker
-Protected
remove-- remove
Worker(worker: Worker): void
+- Defined in src/pools/cluster/fixed.ts:80
To Worker
+Protected
send+- send
To Worker(worker, message): void
-
-
-
-
+-
+
-
-
-
+
+
-
+- Defined in src/pools/abstract-pool.ts:266
+
-
+- Defined in src/pools/abstract-pool.ts:218
+
+
+
+
-
Removes the given worker from the pool.
+Sends a message to the given worker.
Parameters
worker: Worker
-The worker that will be removed.
+worker: Worker
+The worker which should receive the message.
+message: MessageValue<Data, unknown>
+The message.
Returns void
Inherited from FixedClusterPool.removeWorker
+Inherited from FixedClusterPool.sendToWorker
-- Defined in src/pools/abstract-pool.ts:277
To Worker
-Protected
send-- send
To Worker(worker: Worker, message: MessageValue<Data, unknown>): void
+- Defined in src/pools/cluster/fixed.ts:75
set Tasks Queue Options
++- set
Tasks Queue Options(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
Inherited from FixedClusterPool.sendToWorker
+Inherited from FixedClusterPool.setTasksQueueOptions
-- Defined in src/pools/cluster/fixed.ts:75
set Worker Choice Strategy
--- set
Worker Choice Strategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void
+
+- set
Worker Choice Strategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void
-
-
-
-
+
+-
+
{@inheritDoc}
+Sets the worker choice strategy in this pool.
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+The worker choice strategy.
+
+Optional
workerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Returns void
Inherited from FixedClusterPool.setWorkerChoiceStrategy
-- Defined in src/pools/abstract-pool.ts:156
set Worker Choice Strategy Options
++- set
Worker Choice Strategy Options(workerChoiceStrategyOptions): void
+-
+
+
+
+
+
Sets the worker choice strategy options in this pool.
+Parameters
++-
+
workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
+The worker choice strategy options.
+Returns void
Inherited from FixedClusterPool.setWorkerChoiceStrategyOptions
++- Defined in src/pools/abstract-pool.ts:244
Hook
-Protected
setup-- setup
Hook(): void
+
+- setup
Hook(): void
-
-
-
+- Defined in src/pools/cluster/fixed.ts:59
+
-
+- Defined in src/pools/abstract-pool.ts:504
+
+
-
-
{@inheritDoc}
+Setup hook to execute code before worker node are created in the abstract constructor. +Can be overridden
Returns void
Inherited from FixedClusterPool.setupHook
-- Defined in src/pools/cluster/fixed.ts:59
Listener
-Protected
worker-- worker
Listener(): ((message: MessageValue<Response, unknown>) => void)
+
+- worker
Listener(): ((message) => 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) => void)
-- (message: MessageValue<Response, unknown>): void
+
+- (message): void
-
-
@@ -527,15 +613,16 @@ Can be overridden.
-
-
+
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.
Parameters
message: MessageValue<Response, unknown>
message: MessageValue<Response, unknown>
Returns void
Inherited from FixedClusterPool.workerListener
-- Defined in src/pools/abstract-pool.ts:364
-
+Settings
Settings
Member Visibility
Theme
+
On This Page
-- poolifier
-
Generated using TypeDoc