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 emitter.
+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's emitter.
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
@@ -33,16 +33,16 @@ When the maximum number of workers is reached, an event is emitted. If you wantResponse = unknown
-Type of response of execution. This can only be serializable data.
+Type of execution response. This can only be serializable data.
Hierarchy
-- FixedClusterPool<Data, Response>
+
- FixedClusterPool<Data, Response>
- DynamicClusterPool
@@ -56,40 +56,36 @@ When the maximum number of workers is reached, an event is emitted. If you wantemitter?
file
Properties
Accessors
-Methods
-constructor
-- new
+- new
-
Constructs a new poolifier dynamic cluster pool.
opts: ClusterPoolOptions = {}
Options for this dynamic cluster pool.
Returns DynamicClusterPool<Data, Response>
Properties
OptionalReadonlyemitter{@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.Readonlyfile
+ProtectedReadonlymaxReadonlymaxMaximum number of workers that can be created by this pool.
-ProtectednextId of the next message.
-ReadonlynumberReadonlyopts
-ProtectedpromiseThe promise map.
+
+ProtectedpromiseThe 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.
-ProtectedworkerWorker 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.
-Readonlyworkers{@inheritDoc}
-
-Readonlyworkers{@inheritDoc}
+
+ReadonlyworkerPool worker nodes.
Accessors
-busy
-+
+- get busy(): boolean
-
-
-
+
+
+
+
+
+- get numberOfRunningTasks(): number
-
-
- Defined in src/pools/abstract-pool.ts:176
+Protectedbusy{@inheritDoc}
+Whether the pool is busy or not.
+The pool busyness boolean status.
Returns boolean
-number
-+- Defined in src/pools/cluster/dynamic.ts:48
+Protectedfull+- get full(): boolean
+-
+
Whether the pool is full or not.
+The pool filling boolean status.
+Returns boolean
+Privatenumber+- get numberOfQueuedTasks(): number
+-
+
Number of tasks queued in the pool.
+Returns number
+Privatenumber{@inheritDoc}
+Number of tasks running in the pool.
Returns number
+type
-- get type(): PoolType
+- get type(): PoolType
-
-
-
+
{@inheritDoc}
+Pool type.
+If it is
'dynamic', it provides themaxproperty.Returns PoolType
Methods
-
+ProtectedafterProtectedafter-- after
+- after
-
-
-
-
-
-
+- Defined in src/pools/abstract-pool.ts:335
- after
-
-
-
-
+
-
-- Defined in src/pools/cluster/fixed.ts:93
+
+
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
Protectedafter{@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
maxListenersor binding themain-worker<->workerconnection if not bind by default.Parameters
worker: Worker
worker: Worker
+The newly created worker.
+Returns void
+ProtectedbeforeProtectedbefore-- before
+- before
-
-
-- Defined in src/pools/abstract-pool.ts:324
+
+
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
+ProtectedchooseProtectedchoose-- choose
+- choose
-
-
- create
-
-
- Defined in src/pools/abstract-pool.ts:430
- create
-
-
- Defined in src/pools/cluster/fixed.ts:88
- destroy(): Promise<void>
-
-
-
+
+- destroy
-
-
-
-
+
+- Defined in src/pools/cluster/fixed.ts:69
-
-
-
-- Defined in src/pools/abstract-pool.ts:256
+
+
-
-
-
\ No newline at end of file
+
\ No newline at end of file
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
ProtectedcreateCreates 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
+Protectedcreate{@inheritDoc}
+Returns a newly created worker.
Returns Worker
+destroy
{@inheritDoc}
+Shutdowns every current worker in this pool.
Returns Promise<void>
-destroy
-+- Defined in src/pools/abstract-pool.ts:287
+Protecteddestroy{@inheritDoc}
+Shutdowns the given worker.
Parameters
worker: Worker
worker: Worker
+A worker within
+workerNodes.Returns void
execute
-- execute(data: Data): Promise<Response>
+- execute(data: Data): Promise<Response>
-
-
-
-
-
{@inheritDoc}
+Performs the task specified in the constructor with the data parameter.
+ +Returns
Promise that will be resolved when the task is successfully completed.
Parameters
data: Data
Returns Promise<Response>
Returns Promise<Response>
find
--- find
--
-
{@inheritDoc}
-Returns false | Worker
get
+find
-- get
+- find
-
-
-
-
{@inheritDoc}
-Parameters
---
-
worker: Worker
Returns undefined | number
get
--- get
--
-
-
-
-
-- Defined in src/pools/abstract-pool.ts:249
+
+
+- Defined in src/pools/abstract-pool.ts:244
- is
-
-
-
+
+
-
-
+- Defined in src/pools/cluster/fixed.ts:80
+- Defined in src/pools/cluster/fixed.ts:75
+- Defined in src/pools/abstract-pool.ts:209
- setup
-
-
- Defined in src/pools/cluster/fixed.ts:59
+- Defined in src/pools/abstract-pool.ts:453
+
+
-
-
-
+- constructor
+- emitter
+- file
+- max
+- number
+- opts
+- promise
+- worker
+- worker
+- busy
+- full
+- number
+- number
+- type
+- after
+- after
+- before
+- choose
+- create
+- create
+- destroy
+- destroy
+- execute
+- find
+- internal
+- is
+- register
+- send
+- set
+- setup
+- worker
+
{@inheritDoc}
+Finds a free worker node key based on the number of tasks the worker has applied.
+If a worker is found with
+0running tasks, it is detected as free and its worker node key is returned.If no free worker is found,
+ +-1is returned.Returns
A worker node key if there is one,
-1otherwise.Parameters
---
-
worker: Worker
Returns number
-get
--- get
--
-
-
-
{@inheritDoc}
-Parameters
---
-
worker: Worker
Returns undefined | number
+ProtectedinternalProtectedinternal-- internal
+- internal
-
Returns boolean
Protectedis{@inheritDoc}
+Should return whether the worker is the main worker or not.
Returns boolean
-register
--- register
+- Defined in src/pools/cluster/fixed.ts:64
+Protectedregister+- register
-
-
-
-
+-
-
-
{@inheritDoc}
+Registers a listener callback on the given worker.
Type Parameters
@@ -492,103 +467,96 @@ Can be overridden.Parameters
worker: Worker
worker: Worker
+The worker which should register a listener.
+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
-Protectedremove-- remove
--
-
-
-
Removes the given worker from the pool.
-Parameters
---
-
worker: Worker
-The worker that will be removed.
-Returns void
Protectedsend-- send
+- send
-
-
-
-
+-
-
+
{@inheritDoc}
+Sends a message to the given worker.
Parameters
worker: Worker
worker: Worker
+The worker which should receive the message.
+message: MessageValue<Data, unknown>
message: MessageValue<Data, unknown>
+The message.
+Returns void
set
-- set
+- set
-
-
-
-
+
{@inheritDoc}
+Sets the worker choice strategy in this pool.
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"
+The worker choice strategy.
+Returns void
Protectedsetup{@inheritDoc}
+Setup hook to execute code before worker node are created in the abstract constructor. +Can be overridden
Returns void
+Protectedworker-- worker
+- worker
-
-
-
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.
Parameters
message: MessageValue<Response, unknown>
message: MessageValue<Response, unknown>
Returns void
-
+Settings
Settings
Member Visibility
Theme
Generated using TypeDoc