A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.
This thread pool creates new threads when the others are busy, up to the maximum number of threads.
-When the maximum number of threads is reached, an event is emitted. If you want to listen to this event, use the pool's emitter.
+When the maximum number of threads is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's emitter.
A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.
This thread pool creates new threads when the others are busy, up to the maximum number of threads. -When the maximum number of threads is reached, an event is emitted. If you want to listen to this event, use the pool's
+When the maximum number of threads is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool'semitter.emitter.Author
Alessandro Pio Ardizio
@@ -28,21 +28,21 @@ When the maximum number of threads 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
-- FixedThreadPool<Data, Response>
+
- FixedThreadPool<Data, Response>
- DynamicThreadPool
@@ -50,52 +50,55 @@ When the maximum number of threads is reached, an event is emitted. If you want
constructor
+constructor
emitter?
-fileemitter?
+file
busy
-numberbusy
+full
+number
afterafter
+
+
-
-
-
-
-
-
-
-
-
+- Defined in src/pools/thread/dynamic.ts:29
+
emitter?: PoolEmitter
-emitter?: PoolEmitter
+
+- Defined in src/pools/abstract-pool.ts:42
+
file
-file
+
-max: number
+- Defined in src/pools/abstract-pool.ts:77
+
+max: number
-
+- Defined in src/pools/thread/dynamic.ts:31
+
number
+number
-
+- Defined in src/pools/abstract-pool.ts:76
+
opts: PoolOptions<ThreadWorkerWithMessageChannel>
+opts: PoolOptions<ThreadWorkerWithMessageChannel>
-
+- Defined in src/pools/abstract-pool.ts:78
+
promise
-promise
+
+- Defined in src/pools/abstract-pool.ts:52
+
worker
-worker
+
-workers: WorkerType<ThreadWorkerWithMessageChannel>[] = []
-- Defined in src/pools/abstract-pool.ts:62
+
+worker
+
+- Defined in src/pools/abstract-pool.ts:39
-
Constructors
-Properties
-Accessors
-Methods
-Constructors
-constructor
--- new
+
+- new
-
-
-
+
-
-
Constructs a new poolifier dynamic thread pool.
Type Parameters
Data = unknown
Data = unknown
Response = unknown
Response = unknown
Parameters
min: number
+min: number
Minimum number of threads which are always active.
max: number
+max: number
Maximum number of threads that can be created by this pool.
filePath: string
+filePath: string
Path to an implementation of a
ThreadWorkerfile, which can be relative or absolute.opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
+opts: PoolOptions<ThreadWorkerWithMessageChannel> = {}
Options for this dynamic thread pool.
Returns DynamicThreadPool<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.
-ReadonlyfilePath to the worker-file.
+Path to the worker file.
-ProtectedReadonlymax
+ReadonlymaxMaximum number of threads that can be created by this pool.
-ReadonlynumberNumber of workers that this pool should manage.
-ReadonlyoptsOptions for the pool.
-ProtectedpromiseThe 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.
-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}
+
+ReadonlyworkerPool worker nodes.
Accessors
-busy
-+
+- get busy(): boolean
-
-
-
+
+
+
+
+
+- get numberOfRunningTasks(): number
-
-
+- Defined in src/pools/abstract-pool.ts:185
+
+Protectedbusy{@inheritDoc}
+Whether the pool is busy or not.
+The pool busyness boolean status.
Returns boolean
-number
-+- Defined in src/pools/thread/dynamic.ts:49
+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
-
-Protectedafter-- after
+
+
+Protectedafter+- after
-
-
-
-
-
-
+- 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: ThreadWorkerWithMessageChannel
+worker: ThreadWorkerWithMessageChannel
The worker.
message: MessageValue<Response, unknown>
+message: MessageValue<Response, unknown>
The received message.
Returns void
-
-Protectedafter-- after
+
+- after
-
-
-
-
+
{@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: ThreadWorkerWithMessageChannel
worker: ThreadWorkerWithMessageChannel
+The newly created worker.
+Returns void
-Protectedbefore-- before
+- Defined in src/pools/thread/fixed.ts:85
+Protectedbefore+- before
-
-
-
+
+
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
-Protectedchoose-- choose
+- Defined in src/pools/abstract-pool.ts:375
+Protectedchoose+- choose
-
-
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, ThreadWorkerWithMessageChannel]
+
-Protectedcreate-- create
+
+- create
-
-
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 ThreadWorkerWithMessageChannel
+
-Protectedcreate-- create
+
+- create
-
-
-
\ No newline at end of file
+
\ No newline at end of file
{@inheritDoc}
+Returns a newly created worker.
Returns ThreadWorkerWithMessageChannel
+destroy
--- destroy(): Promise<void>
+
+- destroy(): Promise<void>
-
-
+
-
-
+
+
-
-
+
+
{@inheritDoc}
+Shutdowns every current worker in this pool.
Returns Promise<void>
+
+Protecteddestroy+- destroy
-
-
-
-
-
{@inheritDoc}
+Shutdowns the given worker.
Parameters
worker: ThreadWorkerWithMessageChannel
Returns Promise<void>
Returns Promise<void>
execute
--- execute(data: Data): Promise<Response>
+- Defined in src/pools/thread/fixed.ts:54
enable
++- enable
-
-
-
-
-
{@inheritDoc}
+Enables/disables the worker tasks queue in this pool.
Parameters
data: Data
Returns Promise<Response>
Returns void
find
--- find
+- 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
-
-Protectedinternal-- internal
+
+
+
Parameters
++-
+
+Optionaldata: DataThe task input data for the specified worker function. This can only be serializable data.
+Returns Promise<Response>
+Protectedinternal+- internal
-
Returns boolean
-Protectedis-- is
+
+- is
-
-
-
+
+
-
-
+
+
+- constructor
+- emitter
+- file
+- max
+- number
+- opts
+- promise
+- worker
+- worker
+- busy
+- full
+- number
+- number
+- type
+- after
+- after
+- before
+- choose
+- create
+- create
+- destroy
+- destroy
+- enable
+- execute
+- internal
+- is
+- register
+- send
+- set
+- set
+- set
+- setup
+- worker
{@inheritDoc}
+Should return whether the worker is the main worker or not.
Returns boolean
-register
--- register
+- Defined in src/pools/thread/fixed.ts:49
+Protectedregister+- register
-
-
-
-
+
-
-
+-
-
-
-
{@inheritDoc}
+Registers a listener callback on the given worker.
Type Parameters
Message
Message
Parameters
messageChannel: ThreadWorkerWithMessageChannel
worker: ThreadWorkerWithMessageChannel
+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
-Protectedremove-- remove
+- Defined in src/pools/thread/fixed.ts:70
+Protectedsend+- send
-
-
-
+
+
-
+- 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: ThreadWorkerWithMessageChannel
-The worker that will be removed.
+worker: ThreadWorkerWithMessageChannel
+The worker which should receive the message.
+message: MessageValue<Data, unknown>
+The message.
Returns void
-Protectedsend-- send
+- Defined in src/pools/thread/fixed.ts:62
set
++- set
-
-
-
-
--
-
+
{@inheritDoc}
+Sets the worker tasks queue options in this pool.
Parameters
worker: ThreadWorkerWithMessageChannel
message: MessageValue<Data, unknown>
tasksQueueOptions: TasksQueueOptions
+The worker tasks queue options.
+Returns void
set
--- set
+
+- set
-
-
-
-
+-
+
{@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.
+
+OptionalworkerChoiceStrategyOptions: WorkerChoiceStrategyOptionsThe worker choice strategy options.
+Returns void
set
++- set
+-
+
+
+
Sets the worker choice strategy options in this pool.
+Parameters
++-
+
workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
+The worker choice strategy options.
+Returns void
-Protectedsetup-- setup
+
+- setup
-
-
+- Defined in src/pools/abstract-pool.ts:360
+
+- Defined in src/pools/abstract-pool.ts:504
+
+
-
-
Setup hook that can be overridden by a Poolifier pool implementation -to run code before workers are created in the abstract constructor.
+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) => void)
-- (message: MessageValue<Response, unknown>): void
+
+- (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.
Parameters
message: MessageValue<Response, unknown>
message: MessageValue<Response, unknown>
Returns void
-
+Settings
Settings
Member Visibility
Theme
+
On This Page
-- poolifier
-
Generated using TypeDoc